Redoc deployment guide
Redoc offers multiple options for rendering your OpenAPI definition. You should select the option that best fits your needs.
The following options are supported:
- Live demo: The live demo offers a fast way to see how your OpenAPI renders with Redoc. A version of the Swagger Petstore API is displayed by default. To test it with your own OpenAPI definition, enter the URL for your definition 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 start
OpenAPI definition
You need an OpenAPI definition. For testing purposes, you can use one of the following sample OpenAPI definitions:
- OpenAPI 3.0
- OpenAPI 2.0
For more information on the OpenAPI specification, refer to the Learning OpenAPI 3 section in the documentation.
How to run Redoc locally
If you want to view your Redoc output locally, you can simulate an HTTP server.
Python
If you have Python 3 installed, cd
into your project directory and run the following command:
python3 -m http.server
If you have Python 2 installed, cd
into your project directory and run the following command:
python -m SimpleHTTPServer 8000
The output after entering the command provides the local URL where the preview can be accessed. To exit the preview, use control-C
.
Node.js
If you have Node.js installed, install http-server
using the following npm command:
npm install -g http-server
Then, cd
into your project directory and run the following command:
http-server
The output after entering the command provides the local URL where the preview can be accessed. To exit the preview, use control-C
.