/
Using Redoc to Generate API Reference Documentation

Using Redoc to Generate API Reference Documentation



Redoc is Open Source



ReDoc uses the OpenAPI specification and generates a responsive site with a three-panel design. It pulls markdown headings from the OpenAPI description field into the side menu, and supports deep linking.

ReDoc aims to make deployment extremely easy, provides a wide support for OpenAPI objects, and offers interactive documentation for nested objects. You can include code samples via a third-party extension.

For Example:
https://redocly.github.io/redoc/

This link has instructions for installing and using Redoc: https://github.com/Redocly/redoc

redoc-cli bundle [spec] - bundles spec and ReDoc into zero-dependency HTML file.
To use in command line "redoc-cli bundle ./specs/api-description-v2.yml --output ./docs/index.html" it creates an html2  file

Related content

DOC Comparison of Open Source Documentation Systems: ReStructuredText and Diátaxis
DOC Comparison of Open Source Documentation Systems: ReStructuredText and Diátaxis
More like this
APPC Documentation
APPC Documentation
More like this
DOC Project Proposal
DOC Project Proposal
More like this
ONAP DDF Documentation session
ONAP DDF Documentation session
More like this
Proposed Phase 1+ OpenAPI 2.0 / Swagger Style Guide
Proposed Phase 1+ OpenAPI 2.0 / Swagger Style Guide
More like this
Investigation of Swagger Documentation Generation
Investigation of Swagger Documentation Generation
More like this