Redocly/redoc
Redoc
Redoc is an API documentation generator that transforms standard API specification files into interactive, responsive, and highly customizable web-based documentation interfaces. It provides a three-panel layout that includes synchronized navigation, code samples, and search functionality, allowing developers to explore endpoints and schemas directly within a browser-based environment.
Beyond rendering, the project functions as an API governance toolkit that enforces structural standards and quality rules across API definitions. It includes a suite of processing utilities for bundling, splitting, and programmatically transforming large specification files, ensuring that documentation remains manageable and cohesive throughout the development lifecycle.
The platform supports extensive visual and functional customization, allowing users to tailor the documentation appearance through centralized configuration files or by embedding the interface directly into existing web applications. It also offers advanced metadata extensions and middleware-based transformation tools, enabling developers to modify content, group operations, and inject custom branding directly into the generated output.
Features
- API Documentation Generators - Transforms standard API specification files into interactive, responsive web-based documentation.
- API Documentation Generators - Renders interactive API documentation from specification files for integration into web applications.
- API Explorers - Provides a browser-based interface for navigating, searching, and testing API endpoints.
- Interactive Documentation Interfaces - Renders responsive three-panel layouts that enable developers to explore API endpoints and schemas interactively.
- API Governance Toolkits - Validates API definitions against structural standards to ensure consistency.
- API Documentation Viewers - Renders technical specifications into a responsive interface for exploring endpoints and schemas.
- OpenAPI Processors - Bundles, splits, and transforms large API definition files into cohesive structures.
- Documentation Generators - Provides a centralized configuration system to customize the appearance and behavior of generated documentation pages.
- API Documentation - Modern documentation renderer with advanced theming and multi-language support.
- API Specification Tools - Generates interactive API reference documentation from specifications.
- Project Documentation Examples - Features GIF animations and TL;DR usage sections.
- Automated Governance Tools - Enforces consistent quality standards by validating API definitions against rulesets.
- Governance Frameworks - Validates API revisions against rulesets to maintain consistent quality throughout the development lifecycle.
- Declarative UI Components - Transforms structured API definitions into interactive web interfaces using a declarative model.
- API Specification Managers - Enables splitting, bundling, and merging of large API description files.
- Data Bundlers - Resolves and merges fragmented API specification files into a single cohesive document.
- Specification Extensions - Applies vendor-specific extensions to API root objects to enable custom metadata and behavior.
- Static Analysis - Evaluates API definition files against rulesets to enforce structural integrity before generation.
- Tagging Systems - Organizes API operations into logical categories to improve navigation and discoverability in documentation.
- Documentation Components - Provides configuration options to modify the visual style and layout of rendered API documentation.
- Middleware Frameworks - Applies programmatic filters and decorators to API definitions during the build process.
- Operation Metadata - Controls the appearance and behavior of specific API endpoints by attaching custom properties to operation objects.
- Transformation Pipelines - Filters endpoints and applies decorators to modify API content during the build process.
- Embedded Documentation Components - Enables embedding dynamic API documentation into web applications via code and configuration.
