What is this?
Redoc is an open-source tool that generates API reference documentation from OpenAPI (formerly Swagger) definitions — it turns your spec file into a polished, readable reference page.
Redoc is an open-source tool that generates API reference documentation from OpenAPI (formerly Swagger) definitions — it turns your spec file into a polished, readable reference page.What does the generated documentation look like?A responsive three-panel web page: a search bar and navigation menu on the left, the documentation itself in the center, and request and response examples on the right.
A responsive three-panel web page: a search bar and navigation menu on the left, the documentation itself in the center, and request and response examples on the right.How do I generate docs from my spec file?With Node installed, run the Redocly CLI via npx against your OpenAPI definition — it writes a redoc-static.html file you can open directly in your browser.
With Node installed, run the Redocly CLI via npx against your OpenAPI definition — it writes a redoc-static.html file you can open directly in your browser.Do I need Node for this?The CLI route needs Node. If you'd rather not set that up, there's a Docker image, an HTML tag you can drop into any page, and a React component for app integration.
The CLI route needs Node. If you'd rather not set that up, there's a Docker image, an HTML tag you can drop into any page, and a React component for app integration.What am I missing by using this instead of Redocly's hosted product?Redoc is the community edition. The paid hosted version adds a try-it console, automated code samples, fully custom styles, a mock server, and AsyncAPI and GraphQL support.
Redoc is the community edition. The paid hosted version adds a try-it console, automated code samples, fully custom styles, a mock server, and AsyncAPI and GraphQL support.Which API description formats does it accept?OpenAPI 3.1, OpenAPI 3.0, and legacy Swagger 2.0 definitions are all supported, so older Swagger specs work without conversion.
OpenAPI 3.1, OpenAPI 3.0, and legacy Swagger 2.0 definitions are all supported, so older Swagger specs work without conversion.Can I preview my docs without installing anything?Yes — there's an online demo that renders a sample Petstore API by default; enter the URL of your own OpenAPI definition and select TRY IT to see how Redoc renders it.
Yes — there's an online demo that renders a sample Petstore API by default; enter the URL of your own OpenAPI definition and select TRY IT to see how Redoc renders it.Is the CLI only good for generating the HTML file?No — the Redocly CLI also does linting and bundling of your OpenAPI files, so docs generation can fold into a broader API workflow.
No — the Redocly CLI also does linting and bundling of your OpenAPI files, so docs generation can fold into a broader API workflow.Who actually uses Redoc?The showcase lists organizations like Docker Engine, Zuora, Discourse, Rebilly, APIs.guru, and Quaderno API among users of Redocly tools.
The showcase lists organizations like Docker Engine, Zuora, Discourse, Rebilly, APIs.guru, and Quaderno API among users of Redocly tools.What are similar projects?swagger-ui, swag, forge, swagger-codegen, vibex, fastapi, openapi-generator, scalar
swagger-ui, swag, forge, swagger-codegen, vibex, fastapi, openapi-generator, scalarWhich topics is it in?openapi-specification, openapi3, documentation-generator, api-documentation, swagger, documentation-tool, openapi, reactjs, documentation, rest-api, hacktoberfest, npm
openapi-specification, openapi3, documentation-generator, api-documentation, swagger, documentation-tool, openapi, reactjs, documentation, rest-api, hacktoberfest, npm