Redoc: OpenAPI documentation generator
React component rendering OpenAPI specifications as interactive HTML documentation.
Learn more about redoc
Redoc is a documentation generation tool built as a React component that consumes OpenAPI 3.1, OpenAPI 3.0, and Swagger 2.0 specifications. It parses API definitions and renders them as interactive HTML documentation with a three-panel responsive design. The tool is distributed as a CLI utility, standalone JavaScript bundle, React component, and Docker image for flexible deployment options. Common use cases include generating static documentation sites, embedding API docs in existing web applications, and integrating documentation into development workflows.
Three-panel layout
Provides a responsive design with synchronized menu navigation, central documentation content, and side-by-side request/response examples. The layout adapts to different screen sizes while maintaining the multi-panel structure.
Multiple specification support
Handles OpenAPI 3.1, OpenAPI 3.0, and Swagger 2.0 definitions, allowing documentation generation from legacy and current API specifications without conversion.
Flexible deployment options
Available as a CLI tool, standalone JavaScript bundle for HTML embedding, React component for application integration, and Docker image for containerized environments. Supports both local file and remote URL-based specification loading.
import { RedocStandalone } from 'redoc';
function APIDocumentation() {
return (
<RedocStandalone
specUrl="https://api.example.com/openapi.json"
/>
);
}Patches a security vulnerability by upgrading the mobx-react dependency; no breaking changes or new requirements noted.
- –Upgrade mobx-react to a patched version to mitigate a security vulnerability.
- –Release notes do not specify the CVE identifier or severity of the vulnerability addressed.
Accessibility improvements for keyboard navigation in menu items and JSON viewer; no breaking changes or new requirements.
- –Use arrow keys and Enter to navigate menu items without a mouse for improved accessibility compliance.
- –Expand and collapse JSON nodes in the viewer using keyboard shortcuts for screen reader and keyboard-only workflows.
Patches prototype pollution vulnerability in ≤2.2.0 and adds React 19 support; upgrade immediately if on affected versions.
- –Upgrade from redoc ≤2.2.0 to eliminate a prototype pollution security flaw.
- –React 19 is now supported in package.json peer dependencies alongside earlier versions.
Top in Developer Tools
Related Repositories
Discover similar tools and frameworks used by developers
corepack
Enforces package manager versions specified in package.json.
cadvisor
Daemon for monitoring container resource usage and metrics.
posthog
Event tracking, analytics, and experimentation platform.
PyMuPDF
Python bindings for MuPDF document processing library.
jsPDF
Generate PDF documents in-browser with JavaScript APIs.