Skip to content
Last updated

Redoc CE deployment guide

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

Redoc CE supports the following rendering methods:

  • Live demo: The live demo offers a fast way to see how your OpenAPI renders with Redoc CE. A version of the Redocly Museum API is displayed by default. To test it with your own OpenAPI description, enter the URL for your description and select Try it.
  • HTML element: Using the HTML element works well for typical website deployments.
  • React component: Using the React component is an option for users with a React-based application.
  • Docker image: Using the Docker image works in a container-based deployment.
  • Redocly CLI: Using the Redocly CLI is an option for users who prefer to use a command-line interface.

Before you begin

To work with Redoc CE, make sure you have:

  • an OpenAPI description file
  • a utility that simulates an HTTP server

OpenAPI description

You need an OpenAPI description. For testing purposes, you can use one of the following sample OpenAPI descriptions:

Local HTTP server

To view your Redoc CE output locally, you can simulate an HTTP server.

Python

To install an HTTP server with Python:

Python 3

  1. cd into your project directory.
  2. run the following command:
python3 -m http.server

Python 2

  1. cd into your project directory.
  2. run the following command:
python -m SimpleHTTPServer 8000

The output provides the local URL where you can access the preview.

To exit the preview, press control+C.

Node.js

To install http-server with Node.js:

  1. In your CLI, in your project directory, run the the following command:
npx http-server
  1. After the installation completes, run:
http-server

The output provides the local URL where you can access the preview.

To exit the preview, press control+C.

Resources

 
Next page