# Redoc

Redoc is Redocly's tool for generating API documentation from API description files.

## Features

- **API documentation** - transform API description files into responsive, human-readable API documentation with automatically generated code samples
- Supported specifications:
  - **OpenAPI** (formerly Swagger)
  - **GraphQL**
  - **AsyncAPI**
  - **SOAP**
- **Mock servers** - test your OpenAPI documentation with automatically created mock server at your custom domain
- **Linting** - use built-in rules or create custom rules to govern your APIs
- **Redocly Integration** - works seamlessly with Revel branding, multi-product support, and localization and with Reef for internal catalogs

## Live demo

For a demo of Redoc, see our [Museum API](https://redocly.com/demo/openapi/museum-api).

## Installation

Install Redoc using npm:

```bash
npm install @redocly/redoc
```

Or using pnpm:

```bash
pnpm add @redocly/redoc
```

Or using yarn:

```bash
yarn add @redocly/redoc
```

## Usage

Redoc is designed to work seamlessly as part of the Redocly ecosystem. It integrates with:

- **Revel** - for localization, branding, and multi-product support
- **Reef** - for internal service catalogs
- **Realm** - the complete combination of Redoc, Revel, and Reef
- **Reunite** - for docs-as-code workflows and collaboration

## Support

- [Documentation](https://redocly.com/docs)
- [Contact the Redocly team](https://redocly.com/contact-us)

---

Built with 💙 by Redocly