Redoc CE deployment guide

Redoc CE offers multiple ways of rendering your API description. Choose a method that best suits your needs.

Redoc CE supports the following rendering methods:

• Redocly CLI: build a single HTML file with your documentation from the command line.
• HTML element: add a <redoc> element and a script tag to any web page. Use this method for typical website deployments.
• JavaScript init function: initialize Redoc CE from your own script. Use this method to render into an existing container, or to pass options that are objects or arrays.
• React component: render API documentation in a React-based application.
• Frontend frameworks: render API documentation in Vue, Angular, Next.js, or any other framework.
• Docker image: serve the documentation from a container, configured with environment variables.

All methods share the same configuration options. Every method renders OpenAPI, AsyncAPI, and GraphQL descriptions, see Supported specifications.

To work with Redoc CE, you need an API description file.

You need a JSON or YAML file that contains an OpenAPI or AsyncAPI description, or a .graphql file that contains a GraphQL schema. For testing purposes, you can use one of the following sample description files:

• OpenAPI 3.2
  • Redocly Cafe API
• OpenAPI 3.1
  • Museum Example API
• OpenAPI 3.0
  • Petstore Sample OpenAPI description
• Swagger 2.0
  • Thingful OpenAPI description
  • Fitbit Plus OpenAPI description
• AsyncAPI
  • Redocly Cafe events
• GraphQL
  • Redocly Cafe schema

• Redoc CE quickstart guide - Build documentation from an API description in one HTML file
• Supported specifications - Supported OpenAPI, AsyncAPI, GraphQL, and MCP inputs and the detection rules
• Learning OpenAPI 3 - The OpenAPI 3.x specification
• Configure Redoc CE - Configuration options for Redoc CE 3.x