{"repo":"Redocly/redoc","free":true,"listed":false,"github":"https://github.com/Redocly/redoc","clone":"git clone https://github.com/Redocly/redoc.git","description":"📘 OpenAPI/Swagger-generated API Reference Documentation","language":"TypeScript","stars":25878,"topics":["openapi","swagger","api-documentation","documentation-tool","documentation-generator","redoc","reactjs","openapi3","hacktoberfest","openapi-specification"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Learn what's coming in Redoc 3.x → Generate beautiful API documentation from OpenAPI About Redoc Redoc is an open source tool for generating documentation from OpenAPI (formerly Swagger) definitions. By default Redoc offers a three-panel, responsive layout: - The left panel contains a search bar and navigation menu. - The central panel contains the documentation. - The right panel contains request and response examples. Live demo If you want to see how Redoc renders your OpenAPI definition, you can try it out online at https://redocly.github.io/redoc/. A version of the Swagger Petstore API is displayed by default. To test it with your own OpenAPI definition, enter the URL for your definition and select TRY IT . Redoc features - Responsive three-panel design with menu/scrolling synchronization - Support for OpenAPI 3.1, OpenAPI 3.0, and Swagger 2.0 - Ability to integrate your API introduction into the side menu - High-level grouping in side menu with the x-tagGroups specification extension - Simple integration with create-react-app - Code samples support (with vendor extension) Usage Redoc is provided as a CLI tool (also distributed as a Docker image), HTML tag, and React component. Generate documentation from the CLI If you have Node installed, quickly generate documentation using npx : The tool outputs by default to a file named redoc-static.html that you can open in your browser. Redocly CLI does more than docs; check it out and add linting, bundling, and more to your API w","default_branch":null,"files":null,"tree":[],"storefront":"/r/Redocly","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Redocly/redoc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}