Your product deserves to be showcased with good-looking online interactive API documentation.
Redoc is an open-source renderer for OpenAPI specifications, enabling a project to publish their API as interactive online documentation. Your users will be able to browse the API methods, parameters, results and view code samples.
Use the latest OpenAPI standard in your API specification, or stay with OAS2 if needed. Redoc supports advanced OpenAPI v3 declarations like nested objects, the discriminator, “one of”, “any of”, “all of”, or nullable, and callbacks which aren’t supported properly in competitor tools.
Setting up your API documentation is as easy as 1,2,3!
Simply enter your OpenAPI definition file and click preview.
Out of the box Redoc uses a fully responsive design that seamlessly switches from 3 panes to 2 panes or 1 pane depending on display size. The Redoc viewer constructor takes a long list of options with which to customize behavior, features, colors, fonts, and more. Make it your own.
Redoc runs as client-side code in the browser. Documentation can even be deployed on static hosting like GitHub Pages. The Redoc code is published to npm for easy integration with your site, or via a CDN. No processing required: The client-side code directly consumes an OpenAPI definition, rendering it completely in the client. Alternatively, you can use our redoc-cli console command tool to generate static documentation.
The left-nav listing can be organized into groups by adding a tag to each operation. Redoc then organizes the operations according to your tags. Redoc includes a search box letting users search for operations rather than scrolling. An operation is an OpenAPI term which is a combination of an endpoint and HTTP method.
Get your API users up to speed faster by supplying sample code right in the documentation. Code samples can be in as many languages as you like.
Help your users navigate the documentation with direct links. Each operation has its own URL.
“ReDoc provides a simple, OpenAPI spec compliant way of delivering attractive, interactive, responsive and up to date documentation that can be deployed anywhere, including integration into your existing continuous integration, and API lifecycle”