Getting started with Redocly API reference docs

Overview

Render your OpenAPI definition(s) as interactive API documentation.

Main features:

  • Support of deeply nested payloads.
  • Try It API console with support for different servers and the OAS3 security schemes.
  • Automated code sample generation.
  • Advanced search.
  • Separate-file embedded markdown for extended introductions.

To use Redocly API reference docs you need an OpenAPI definition (it's compatible with version 2.0, 3.0, and 3.1 of the specification).

If you require Redocly API reference docs to be deployed on-premise only, such as due to specific security constraints, you are available to do that on our enterprise plan via two options:

  • Using an HTML element (easiest)
  • Building static documentation with a CLI tool (medium)

Find our on-premise guide here.