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

Project Activity

See All Activity >

Categories

Documentation

License

MIT License

Follow Redoc

Redoc Web Site

Other Useful Business Software
99.99% Uptime for Your Most Critical Databases Icon
99.99% Uptime for Your Most Critical Databases

Sub-second maintenance. 2x read/write performance. Built-in vector search for AI apps.

Cloud SQL Enterprise Plus delivers near-zero downtime with 35 days of point-in-time recovery. Supports MySQL, PostgreSQL, and SQL Server.
Try Free
Rate This Project
Login To Rate This Project

User Reviews

Be the first to post a review of Redoc!

Additional Project Details

Operating Systems

Linux, Mac, Windows

Programming Language

JavaScript, TypeScript

Related Categories

JavaScript Documentation Software, TypeScript Documentation Software

Registered

2024-08-02