# Reef

Reef is Redocly's API management platform that organizes, aids discovery, and monitors APIs throughout their lifecycle.

## Features

- **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
- **Redocly Integration** - works seamlessly with Redoc for API docs and Revel for localization, branding, and multi-product support

## Installation

Install Reef using npm:

```bash
npm install @redocly/reef
```

Or using pnpm:

```bash
pnpm add @redocly/reef
```

Or using yarn:

```bash
yarn add @redocly/reef
```

## Usage

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

- **Redoc** - for API reference documentation and mock servers
- **Revel** - for localization, branding, and multi-product support
- **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
