Redoc

An open-source API documentation viewer that generates beautiful, responsive, and interactive documentation from OpenAPI (Swagger) specification files.

What You Can Do After Deployment

1. Visit your domain — See the default Petstore API documentation rendered with Redoc
2. Load your own spec — Point Redoc to your OpenAPI/Swagger JSON or YAML spec URL via the SPEC_URL environment variable
3. Explore the three-panel layout — Navigate the left menu, center content, and right code samples
4. Search the API — Use the built-in search to quickly find endpoints and schemas
5. Share deep links — Copy URLs that link directly to specific endpoints or schemas

Key Features

• Three-panel responsive layout with menu, content, and code samples
• Supports OpenAPI 3.1, 3.0, and Swagger 2.0 specifications
• Interactive request/response examples with multiple language samples
• Built-in search functionality across all endpoints and schemas
• Deep linking to specific operations, tags, and schemas
• Automatic code sample generation
• Server-side rendering support for SEO
• Customizable themes and branding options
• Markdown support in descriptions
• Mobile-friendly responsive design

License

MIT — GitHub