redoc

<div align="center">

  **[Learn what's new in Redoc 3.x →](https://redocly.com/redoc-ce)**
  **[Redoc 3.x migration guide →](https://redocly.com/docs/redoc/config-migration)**

# Generate beautiful API documentation from OpenAPI, AsyncAPI, and GraphQL

  [![npm](http://img.shields.io/npm/v/redoc.svg)](https://www.npmjs.com/package/redoc) [![License](https://img.shields.io/npm/l/redoc.svg)](https://github.com/Redocly/redoc/blob/main/LICENSE)

  [![npm](https://img.shields.io/npm/dm/redoc.svg)](https://www.npmjs.com/package/redoc) [![jsDelivr status](https://data.jsdelivr.com/v1/package/npm/redoc/badge)](https://www.jsdelivr.com/package/npm/redoc)
</div>

## About Redoc

Redoc is an open source tool for generating documentation from OpenAPI (formerly Swagger), AsyncAPI, and GraphQL definitions.

By default Redoc offers a three-panel, responsive layout:

- The left panel contains a search bar and navigation menu.
- The central panel contains the documentation.
- The right panel contains request and response examples.

<img alt="Redoc demo" src="./images/redoc-layouts.gif">

## Live demo

If you want to see how Redoc renders your API definition,
you can try it out online at https://redocly.github.io/redoc/.

A version of the Redocly Cafe API is displayed by default.
To test it with your own API definition,
enter the URL for your definition and select **TRY IT**.

## Redoc features

- Responsive three-panel design with menu/scrolling synchronization
- Support for OpenAPI 3.2, OpenAPI 3.1, OpenAPI 3.0, and Swagger 2.0
- Support for AsyncAPI 3.x and GraphQL (SDL) — the format is detected from the document
- MCP (Model Context Protocol) server documentation with the [`x-mcp`](https://redocly.com/docs/platform/content/api-docs/openapi-extensions/x-mcp) specification extension
- Improved built-in search
- **Copy**, **Open in ChatGPT**, and **Open in Claude** actions on every page to work with the docs in your AI assistant
- Dark mode and theming with [CSS variables](https://redocly.com/docs/platform/branding/css-variables)
- Ability to integrate your API introduction into the side menu
- High-level grouping in side menu with the [`x-tagGroups`](https://redocly.com/docs/platform/content/api-docs/openapi-extensions/x-tag-groups) specification extension
- [Simple integration with React](https://redocly.com/docs/redoc/v3.x/deployment/react)
- Code samples support (with the `x-codeSamples` specification extension) <br>

## Usage

Redoc Community Edition is available as an HTML tag, a React component, and via the Redocly CLI (also distributed as a Docker image).

### Generate documentation from the CLI

If you have Node installed, quickly generate documentation using `npx`:

```bash
npx @redocly/cli build-docs openapi.yaml
```

The tool outputs by default to a file named `redoc-static.html` that you can open in your browser.

> [Redocly CLI](https://github.com/Redocly/redocly-cli/) does more than docs; check it out and add linting, bundling, and more to your AP