Skip to content
Get packs

Redoc

Turns OpenAPI, AsyncAPI, or GraphQL specs into a readable, browsable API documentation page.

GitHub Download redoc@3.0.1
Stars
26k
Forks
2.4k
Licence
MIT
Language
TypeScript
Last update
6 days ago
Type
Library

What it is

Redoc is an open source tool that reads an API definition file (OpenAPI, formerly Swagger; AsyncAPI; or GraphQL) and generates a documentation website from it. By default it shows a three-panel layout with navigation on the left, documentation in the middle, and request and response examples on the right. It is used to publish API reference docs without writing them by hand.

  • Generate a single static HTML file from an openapi.yaml file and open it in a browser
  • Embed API reference documentation in a React component inside an existing site
  • Serve API docs from your own server using the npm package
  • Show a side menu grouped by tags with the x-tagGroups extension

Great for

  • Teams that already write OpenAPI or Swagger specs and want public or internal API docs
  • Developers who want to embed API docs in a React app or a plain HTML page
  • Projects that need a static HTML file of their API docs generated from the command line
  • Maintainers who want docs that update automatically when the spec changes

Not ideal for

  • People who need a hosted service with try-it panels, mock servers, or access control; the README points to Redocly's paid hosted product for these, since the community edition does not list them
  • Anyone without an API definition file, because Redoc renders existing specs rather than writing them
  • Teams needing SOAP support, which the README lists only for the hosted product
Step-by-step guide: how to use RedocInstall, first run, examples, tips and FAQs
FastAPI vs RedocRedoc vs Scalar

How to get it

  1. 1

    Install with a package manager

    You'll need: Node.js (required for npx and npm usage)

    Generate static docs from an OpenAPI file

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

    Run it

    • Have an OpenAPI definition file, such as openapi.yaml, ready
    • Run npx @redocly/cli build-docs openapi.yaml in a terminal
    • Open the generated redoc-static.html file in your browser
  3. 3

    Get the most out of it

    • Use the x-tagGroups extension to group tags into categories in the side menu
    • Add the x-logo extension to show your API logo
    • Customize colors and dark mode with CSS variables, as described in the Redocly docs
    • Use x-codeSamples to add code examples to operations
    • Use the Redocly CLI for linting and bundling your API workflow, as the README suggests

Downloads

Source code (.zip)main branch · straight from GitHubRelease redoc@3.0.1Release notes and sourceOfficial website & docsredocly.github.io/redoc/

Strengths

  • Produces a clean, responsive three-panel documentation layout with search and dark mode
  • Accepts several specification formats, including OpenAPI 3.2, 3.1, 3.0, Swagger 2.0, AsyncAPI 3.x, and GraphQL SDL
  • Works as an HTML tag, a React component, or a command-line build, so it fits several setups

Trade-offs

  • Community edition features are limited compared with the paid hosted Redoc product, as the README itself notes
  • Layout and behavior depend on the quality and completeness of the input spec and its extensions
  • The README is truncated here, so details on configuration options and version differences are not fully confirmed

How it compares

ProjectStarsTypeLevelUpdatedBest for
redoc (this)26kLibrarybeginner6 days agoTeams that already write OpenAPI or Swagger specs and want public or internal API docs
fastapi105kLibrarybeginner4 days agoPython developers building JSON APIs or back-end services
scalar16.4kAppbeginner5 days agoDevelopers who already maintain an OpenAPI or Swagger document
bruno48kAppbeginner4 days agoDevelopers who want to test HTTP or GraphQL APIs without an account or cloud sync
swag13kDev toolintermediate1 months agoGo developers who already have a REST API using Gin, Echo, net/http, Fiber, or another listed framework
zustand58.9kLibrarybeginner15 days agoReact developers who want simpler shared state than Redux

Stats synced from GitHub. The assessment above was drafted with AI from the project's README on 2026-10-29 and may miss recent changes — check the README before relying on a command. MIT licence: free to use, modify and distribute, including commercially, as long as you keep the copyright notice.