Repolode
Submit
Redocly

Redocly/redoc

Open-source tool that generates a responsive, three-panel API reference site from OpenAPI, Swagger, AsyncAPI, or GraphQL definitions.

Open-source alternative to:SwaggerUI

View on GitHubWebsite
Stars
25,970
Forks
2,404
Open issues
366
Last commit
17 hours ago

What is it?

Redoc turns an API definition file into a navigable documentation page. It supports OpenAPI 3.2, 3.1, 3.0, and Swagger 2.0, and it also handles AsyncAPI 3.x and GraphQL SDL, detecting the format automatically. The default layout uses three panels: a search bar and navigation menu on the left, the documentation in the center, and request and response examples on the right.

Redoc can be used in several ways. You can build a static HTML file with the Redocly CLI using npx, embed a custom element in an HTML page that loads a spec URL, or render it as a React component. It can be themed with CSS variables, supports dark mode, and reads a set of OpenAPI extensions such as x-logo, x-tagGroups, and x-codeSamples to customize the output.

The project is maintained by Redocly, and the hosted commercial version adds features such as a try-it panel, mock server, and linting.

Key features

  • 01Renders OpenAPI 3.2/3.1/3.0 and Swagger 2.0 definitions
  • 02Supports AsyncAPI 3.x and GraphQL SDL with automatic format detection
  • 03Three-panel responsive layout with synchronized navigation
  • 04Dark mode and theming through CSS variables
  • 05Available as an HTML tag, React component, or Redocly CLI command and Docker image

Use cases

  • Publishing public API reference documentation from an OpenAPI file
  • Embedding API docs inside an existing React or static HTML site
  • Generating a self-contained HTML file for offline or internal sharing

Quick start

  1. 1

    Generate docs from your OpenAPI file with npx (requires Node)

    npx @redocly/cli build-docs openapi.yaml
  2. 2

    Open the generated redoc-static.html file in your browser

Things to know

  • Community Edition lacks features such as the Try-it panel, mock server, and SOAP support, which are only in the hosted Redoc product.
  • Redoc collects anonymous usage and performance data by default, so you must set disable-telemetry or disableTelemetry to opt out.

Topics

#api-documentation#openapi#swagger#documentation-generator#asyncapi#graphql#react#documentation-tool#hacktoberfest#openapi-specification

FAQ

What is redoc?
Open-source tool that generates a responsive, three-panel API reference site from OpenAPI, Swagger, AsyncAPI, or GraphQL definitions. Redoc turns an API definition file into a navigable documentation page. It supports OpenAPI 3.2, 3.1, 3.0, and Swagger 2.0, and it also handles AsyncAPI 3.x and GraphQL SDL, detecting the format automatically. The default layout uses three panels: a search bar and navigation menu on the left, the documentation in the center, and request and response examples on the right.
Is redoc free to use? What license does it have?
redoc is open source under the MIT license. Check the license terms before using it in commercial products.
Is redoc still maintained?
Actively maintained. The last commit to redoc was on Oct 20, 2026.
What can I use redoc for?
Publishing public API reference documentation from an OpenAPI file Embedding API docs inside an existing React or static HTML site Generating a self-contained HTML file for offline or internal sharing
How do I install redoc?
Generate docs from your OpenAPI file with npx (requires Node): npx @redocly/cli build-docs openapi.yaml Open the generated redoc-static.html file in your browser
Where can I get redoc?
The source code and installation instructions are on GitHub: https://github.com/Redocly/redoc

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects