Rebilly/ReDoc
ReDoc
ReDoc is an OpenAPI documentation generator that transforms OpenAPI and Swagger specifications into interactive, three-panel API reference websites. It provides a system for generating these references as standalone static HTML files or as embedded UI components for integration into existing websites and developer portals.
The tool organizes API specifications into a responsive layout featuring a navigation sidebar, detailed endpoint descriptions, and language-specific code samples. It supports the visualization of complex data models by mapping schema definitions to human-readable tables and nested object trees.
The platform includes a command-line utility for automating the export and bundling of specifications into static HTML. Users can further customize the generated content with custom branding, logos, and descriptive badges through specification extensions.
Features
- API Specification UI Rendering - Renders an interactive user interface by parsing OpenAPI and Swagger specifications.
- Code Display & Snippets - Displays language-specific request and response examples alongside API documentation to assist implementation.
- Schema Visualizations - Transforms OpenAPI schema definitions into human-readable tables and nested object trees for data model visualization.
- API Documentation Generators - Automatically transforms API specifications into interactive and human-readable reference pages for developers.
- Document Structure Navigators - Implements a searchable side menu that groups endpoints using tags to organize large API surfaces.
- Interactive Reference Generation - Turns OpenAPI and Swagger specifications into clean, readable, and interactive reference pages.
- Documentation Generators - Transforms OpenAPI and Swagger specifications into interactive three-panel API reference websites.
- Interactive API Reference Rendering - Transforms OpenAPI and Swagger specifications into a responsive three-panel interactive reference website.
- Reference Layouts - Implements a responsive documentation layout with navigation, endpoint descriptions, and code samples.
- API Reference Hosting - Provides the ability to export API specifications as standalone static HTML files for hosting on any web server.
- API Specification Visualisations - Transforms complex Swagger files into a detailed three-panel layout featuring navigation and request examples.
- Three-Panel Layouts - Organizes the interface into a responsive three-panel layout with navigation, documentation, and code samples.
- Static Documentation Export - Includes a command-line utility to bundle API specifications into a standalone HTML file for easy hosting.
- Developer Portals - Enables embedding interactive API documentation and reference content directly into developer portals.
- Custom Metadata Extensions - Supports injecting custom branding and metadata by utilizing non-standard extensions within the API specification.
- Embedded Documentation Components - Allows rendering API reference content within existing websites using custom HTML tags or UI components.
- Standalone Bundling - Compiles the documentation engine and API specification into a single standalone HTML file for serverless hosting.
- Custom Elements - Provides a web component wrapper for embedding API documentation into any HTML page.
- API Documentation - Generates API reference documentation from OpenAPI specs.
- Documentation Tools - Creates three-panel documentation from OpenAPI specifications.
- Web Frameworks - OpenAPI and Swagger-generated API reference documentation.
