redoc: Generate API Documentation from OpenAPI

Overview

Redoc generates API reference documentation from OpenAPI definitions, helping API teams present endpoints, schemas, and examples in a navigable format instead of maintaining reference pages by hand. It supports OpenAPI 3.1, OpenAPI 3.0, and Swagger 2.0.

The project is a fit when you want to render your own API specification as a static page or embed documentation in a web application. Its open source community edition is focused on rendering; some capabilities, such as a try-it console, are listed as features of Redocly's hosted offering instead.

Key Features

• Responsive three-panel layout with search, navigation, documentation, and request and response examples.
• Synchronizes the navigation menu with page scrolling.
• Supports OpenAPI 3.1, OpenAPI 3.0, and Swagger 2.0.
• Supports API introductions and grouped navigation using the x-tagGroups extension.
• Displays code samples through a vendor extension.
• Can be used through the CLI, an HTML element, or a React component.
• Provides configuration options and supports specification extensions for logos, badges, examples, and other display details.

Use Cases

• API teams can generate a browsable reference from an OpenAPI definition and publish it as a static HTML file.
• Developers can embed API documentation in an existing website using the HTML element or React integration.
• Organizations maintaining multiple API specifications can use consistent navigation and rendering without writing each reference page from scratch.
• Documentation maintainers can use specification extensions to organize endpoints and show custom examples or labels.

Project Facts

• Language: TypeScript
• License: MIT
• Stars: 25.9k
• Forks: 2.4k
• Topics: api-documentation, documentation-generator, documentation-tool, hacktoberfest, openapi, openapi-specification, openapi3, openapi31, reactjs, redoc, swagger
• Archived: false

Getting Started

Build a static documentation page from an OpenAPI file with Redocly CLI:

npx @redocly/cli build-docs openapi.yaml

For HTML, React, and deployment options, see the README and Redoc documentation.

Considerations

• Redoc renders an API specification; you need an OpenAPI or Swagger definition to document.
• The README lists specification support for OpenAPI 3.1, OpenAPI 3.0, and Swagger 2.0. Check the documentation for details on supported features and configuration.
• The CLI build command uses Node through npx; other integration methods have their own setup requirements.
• The README distinguishes the open source community edition from hosted Redocly, and lists features such as a try-it console and automated code samples under the hosted offering.