# 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](/docs/redoc/v3.x/deployment/cli):** build a single HTML file with your documentation from the command line.
- **[HTML element](/docs/redoc/v3.x/deployment/html):** add a `<redoc>` element and a script tag to any web page.
  Use this method for typical website deployments.
- **[JavaScript `init` function](/docs/redoc/v3.x/deployment/html#the-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](/docs/redoc/v3.x/deployment/react):** render API documentation in a React-based application.
- **[Frontend frameworks](/docs/redoc/v3.x/deployment/frameworks):** render API documentation in Vue, Angular, Next.js, or any other framework.
- **[Docker image](/docs/redoc/v3.x/deployment/docker):** serve the documentation from a container, configured with environment variables.

All methods share the same [configuration options](/docs/redoc/v3.x/config).
Every method renders OpenAPI, AsyncAPI, and GraphQL descriptions, see [Supported specifications](/docs/redoc/v3.x/supported-specifications).

## Before you begin

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

### API description

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](https://redocly.github.io/redoc/cafe.yaml)
- OpenAPI 3.1
    - [Museum Example API](https://raw.githubusercontent.com/Redocly/museum-openapi-example/main/openapi.yaml)
- OpenAPI 3.0
    - [Petstore Sample OpenAPI description](https://petstore3.swagger.io/api/v3/openapi.json)
- Swagger 2.0
    - [Thingful OpenAPI description](https://raw.githubusercontent.com/thingful/openapi-spec/master/spec/swagger.yaml)
    - [Fitbit Plus OpenAPI description](https://raw.githubusercontent.com/TwineHealth/TwineDeveloperDocs/master/spec/swagger.yaml)
- AsyncAPI
    - [Redocly Cafe events](https://redocly.github.io/redoc/specs/cafe-asyncapi-amqp.yaml)
- GraphQL
    - [Redocly Cafe schema](https://redocly.github.io/redoc/specs/cafe.graphql)

**OpenAPI specification**

For more information on the OpenAPI specification, see [Learning OpenAPI 3](https://redocly.com/docs/resources/learning-openapi/).

## Resources

- **[Redoc CE quickstart guide](/docs/redoc/v3.x/quickstart)** - Build documentation from an API description in one HTML file
- **[Supported specifications](/docs/redoc/v3.x/supported-specifications)** - Supported OpenAPI, AsyncAPI, GraphQL, and MCP inputs and the detection rules
- **[Learning OpenAPI 3](https://redocly.com/docs/resources/learning-openapi/)** - The OpenAPI 3.x specification
- **[Configure Redoc CE](/docs/redoc/v3.x/config)** - Configuration options for Redoc CE 3.x