
Redoc
Open-source OpenAPI renderer with a three-panel docs layout.
About
Redoc is Redocly's open-source API documentation renderer. It turns OpenAPI 3.1, 3.0 and Swagger 2.0 definitions into responsive reference documentation with a signature three-panel layout: searchable navigation on the left, content in the center, and request-response examples on the right.
It ships as a CLI that generates self-contained static HTML, an HTML custom element for embedding in any page, and a React component. The project has over 25,000 GitHub stars and roughly a million weekly npm downloads, with organizations like Docker and Discourse using it for public API docs. Redocly also sells a hosted version with extras like a try-it console and mock servers.
What it can do
- Three-panel responsive API reference rendering
- OpenAPI 3.1, 3.0 and Swagger 2.0 support
- CLI, HTML element and React component outputs
- Vendor extensions for logos, code samples and grouping
Setup
npx @redocly/cli build-docs openapi.yaml to generate a static page.
Prerequisites
Node.js; an OpenAPI or Swagger definition file.
Use cases
Works with
Trust score — 8/10
Scored 8/10 (verified tier, metrics-v1). Evidence: Verified via vendor site/docs/GitHub and reputable coverage, wave 92; Trending score 82/100 from researcher assessment.
Sources
Every fact above was checked against these sources. Where a claim comes from the provider and couldn't be independently verified, the text says so.