{"name":"Redoc: Generate Beautiful API Reference Documentation from OpenAPI","description":"Redoc is an open-source tool designed to generate beautiful, interactive API reference documentation directly from your OpenAPI (formerly Swagger) definitions. It provides a responsive three-panel layout, making it easy to navigate and understand your API. With support for OpenAPI 3.1, 3.0, and Swagger 2.0, Redoc simplifies the process of creating professional API docs.","github":"https://github.com/Redocly/redoc","url":"https://osrepos.com/repo/redocly-redoc","source":"osrepos.com","sourceDescription":"This repository profile is provided by osrepos.com, an open source repository discovery platform.","repositoryProfile":"https://osrepos.com/repo/redocly-redoc","generatedFor":"open source discovery and AI-assisted research","markdown":"https://osrepos.com/repo/redocly-redoc.md","json":"https://osrepos.com/repo/redocly-redoc.json","topics":["api-documentation","openapi","swagger","documentation-generator","documentation-tool","reactjs","TypeScript","API Development"],"keywords":["api-documentation","openapi","swagger","documentation-generator","documentation-tool","reactjs","TypeScript","API Development"],"stars":null,"summary":"Redoc is an open-source tool designed to generate beautiful, interactive API reference documentation directly from your OpenAPI (formerly Swagger) definitions. It provides a responsive three-panel layout, making it easy to navigate and understand your API. With support for OpenAPI 3.1, 3.0, and Swagger 2.0, Redoc simplifies the process of creating professional API docs.","content":"## Introduction\n\nRedoc is a powerful open-source tool designed for generating stunning and interactive API reference documentation directly from your OpenAPI (formerly Swagger) definitions. Developed by Redocly, it transforms complex API specifications into user-friendly, navigable documentation. It offers a responsive three-panel layout, providing a search bar, navigation menu, the main documentation content, and clear request/response examples. Redoc supports OpenAPI 3.1, 3.0, and Swagger 2.0, ensuring broad compatibility for various API projects.\n\n## Installation\n\nRedoc provides flexible installation and usage options, including a command-line interface (CLI) tool, an HTML tag for direct embedding, and a React component.\n\n### Generate documentation from the CLI\n\nIf you have Node.js installed, you can quickly generate documentation using `npx`:\n\nbash\nnpx @redocly/cli build-docs openapi.yaml\n\n\nThis command will output an HTML file, typically named `redoc-static.html`, which you can open in your browser to view your API documentation.\n\n### Add an HTML element to the page\n\nYou can also embed Redoc directly into any HTML page. Create or edit an HTML file and add the following within the `` tags:\n\nhtml\n \n \n\n\nReplace `\"http://petstore.swagger.io/v2/swagger.json\"` with the URL or local path to your OpenAPI definition. For more detailed deployment options, including local installation of the JavaScript library, refer to the [official Redoc documentation](https://redocly.com/docs/redoc/deployment/html/ \"Redoc HTML Deployment Documentation\" target=\"_blank\").\n\n## Examples\n\nRedoc's intuitive design is best experienced through its live demo.\n\n### Live Demo\n\nYou can try Redoc online at [https://redocly.github.io/redoc/](https://redocly.github.io/redoc/ \"Redoc Live Demo\" target=\"_blank\"). The demo displays a version of the Swagger Petstore API by default. You can easily test it with your own OpenAPI definition by entering its URL and selecting \"TRY IT\".\n\n### Three-Panel Layout\n\nBy default, Redoc presents a highly functional three-panel, responsive layout:\n* **Left Panel:** Contains a search bar and a comprehensive navigation menu for your API endpoints.\n* **Central Panel:** Displays the detailed API documentation, including descriptions, parameters, and schemas.\n* **Right Panel:** Shows request and response examples, often with code samples, to help developers understand how to interact with your API.\n\n## Why Use Redoc\n\nRedoc stands out as an excellent choice for API documentation due to several compelling features:\n\n* **Beautiful and Responsive Design:** Its default three-panel layout is not only aesthetically pleasing but also fully responsive, ensuring a great experience on any device.\n* **Broad OpenAPI Support:** It supports OpenAPI 3.1, 3.0, and Swagger 2.0, making it compatible with a wide range of existing API specifications.\n* **Highly Configurable:** Redoc is highly configurable, allowing you to customize its appearance and behavior through various options and [OpenAPI specification extensions](https://redocly.com/docs/api-reference-docs/spec-extensions/ \"Redoc Specification Extensions\" target=\"_blank\").\n* **Easy Integration:** Whether you prefer a CLI tool, embedding directly into HTML, or using it as a React component, Redoc offers straightforward integration paths.\n* **Community and Enterprise Backing:** As an open-source project maintained by Redocly, it benefits from active development and is used by many prominent organizations like Rebilly, Docker Engine, and Zuora.\n\n## Links\n\n* **GitHub Repository:** [https://github.com/Redocly/redoc](https://github.com/Redocly/redoc \"Redoc GitHub Repository\" target=\"_blank\")\n* **Live Demo:** [https://redocly.github.io/redoc/](https://redocly.github.io/redoc/ \"Redoc Live Demo\" target=\"_blank\")\n* **Redoc Documentation:** [https://redocly.com/docs/redoc/](https://redocly.com/docs/redoc/ \"Redoc Official Documentation\" target=\"_blank\")\n* **Redocly CLI Documentation:** [https://redocly.com/docs/cli](https://redocly.com/docs/cli \"Redocly CLI Documentation\" target=\"_blank\")","metrics":{"detailViews":4,"githubClicks":6},"dates":{"published":null,"modified":"2026-03-06T20:36:47.000Z"}}