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)
Project Samples
Categories
DocumentationLicense
MIT LicenseFollow Redoc
You Might Also Like
Enterprise-Grade Monitoring - Zero Compromises
Managing a large, distributed IT environment demands more than basic monitoring. PRTG provides a unified view of your entire infrastructure - across sites, clouds, and hybrid setups. Advanced analytics, customizable dashboards, and granular access controls empower your team to detect issues early and respond fast. Automate reporting, ensure compliance, and scale effortlessly as your network grows. With PRTG, you get reliability, flexibility, and the insights you need to keep your business running at peak performance.
Rate This Project
Login To Rate This Project
User Reviews
Be the first to post a review of Redoc!