# Realm

Realm combines Redoc, Revel, and Reef into a comprehensive API lifecycle management platform.

## Features

- **API documentation** - transform API description files into responsive, human-readable API documentation with automatically generated code samples
- Specification support:
  - **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
- **Catalog** - use rich metadata to organize, search, and filter APIs
- **Scorecard** - run multiple sets of rules against each API
- **API functions** - build custom backend logic within your documentation pages
- **Markdown Docs** - write content in Markdown and enhance it using built-in or custom Markdoc tags
- **API Scout** - monitor your APIs to find ones that are hidden, underused, or duplicate
- **Dynamic client registration** - allow customers to register a client or application, get credentials and gain access to API products
- **Catalog** - use rich metadata to organize, search, and filter APIs
- **Scorecard** - run multiple sets of rules against each API
- **API functions** - build custom backend logic within your documentation pages
- **API Scout** - monitor your APIs to find ones that are hidden, underused, or duplicate
- **Dynamic client registration** - allow customers to register a client or application, get credentials and gain access to API products

## Live demo

You can explore a live deployment of Revel at [https://redocly.com](https://redocly.com) - this website runs entirely on Realm (which includes Revel).

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

## Installation

Install Realm using npm:

```bash
npm install @redocly/realm
```

Or using pnpm:

```bash
pnpm add @redocly/realm
```

Or using yarn:

```bash
yarn add @redocly/realm
```

## Usage

Realm comprises Redoc, Revel, and Reef to form the Redocly ecosystem.
It integrates with 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