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"
/>
);
}Security update bumping mobx-react dependency to address vulnerability.
- –Bumped `mobx-react` dependency to address a security vulnerability
Enhances accessibility with keyboard support for menu items and JSON viewer navigation.
- –enhance accessibility for menu items with keyboard support
- –add keyboard navigation support to JsonViewer component
Fixes prototype pollution vulnerability, adds React 19 support, and unifies configuration system.
- –Prototype Pollution Vulnerability Affecting redoc <=2.2.0
- –unify redoc config
- –add supporting react 19 in package.json
Top in Developer Tools
Related Repositories
Discover similar tools and frameworks used by developers
Git
Snapshot-based version control with distributed repository architecture.
nvm
Per-user Node.js version manager for switching between installed versions via command line on POSIX-compliant shells.
JSON for Modern C++
Header-only C++ library for JSON with STL-like containers.
PowerShell
Cross-platform shell and scripting language for system administration with structured data support.
scrcpy
Mirrors Android devices over USB/TCP with keyboard and mouse control, no root required.