Redoc is an open source tool for generating documentation from OpenAPI (formerly Swagger) definitions. With Redoc, you can generate beautiful API documentation from OpenAPI. Redoc is provided as a CLI tool (also distributed as a Docker image), HTML tag, and React component. If you have Node installed, quickly generate documentation using npx. Open the HTML file in your browser, and your API documentation is shown on the page. Redoc is highly configurable. Redoc offers OpenAPI specification extensions.
Features
- 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
- Responsive three-panel design with menu/scrolling synchronization
- Responsive three-panel design with menu/scrolling synchronization
- 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)
Categories
DocumentationLicense
MIT LicenseFollow Redoc
Other Useful Business Software
MongoDB Atlas runs apps anywhere
MongoDB Atlas gives you the freedom to build and run modern applications anywhere—across AWS, Azure, and Google Cloud. With global availability in over 115 regions, Atlas lets you deploy close to your users, meet compliance needs, and scale with confidence across any geography.
Rate This Project
Login To Rate This Project
User Reviews
Be the first to post a review of Redoc!