# Introduction

At Zuplo we believe that the better the quality of an OpenAPI document, the
better the developer experience will be for the consumers of that API. This
experience is important for the success of an API.

Rate My OpenAPI is a suite of tools designed to help software developers using
OpenAPI to meet high standards of quality and usability when designing and
developing their APIs. Our tools include a website, a CLI, a GitHub Action and
an API, all aimed at ensuring your APIs meet high standards of quality and
usability.

:::warning{title="New API keys required"}
On May 12, 2026, Rate My OpenAPI switched to a new registration system. API keys created before that date no longer work. [Subscribe to the free plan](https://docs.ratemyopenapi.com/pricing) (free forever) to register or log in — a new key is created for you automatically.
:::

## Quickstart

1. [Subscribe to the free plan](https://docs.ratemyopenapi.com/pricing) (free forever) to register or log in. Your API key is created automatically.
2. Copy your API key from the dashboard.
3. Lint your OpenAPI file using the [CLI](./cli) or the [GitHub Action](./github-action).

## Categories of evaluation

Our tools evaluate your OpenAPI definition files and provide a comprehensive
score based on four key categories:

- **Documentation:** Ensure your API is well-documented, making it easy for
  users to understand and use.
- **SDK Generation:** Verify that your API definition supports SDK
  generation, facilitating integration and usage in different programming
  languages.
- **Security:** Check for best practices and standards to ensure your API is
  secure and protected against common vulnerabilities.
- **Completeness:** Ensure your API definition is complete, with all
  necessary endpoints, parameters, and responses accurately defined.

## Tools

### Website

[https://ratemyopenapi.com](https://ratemyopenapi.com) offers a user-friendly
interface for developers to upload and analyze their OpenAPI definition files.

Key features include:

- **Linting:** Upload and lint your OpenAPI files to receive detailed feedback.
- **Comprehensive scoring:** Get a clear, actionable score rating your API's
  documentation, SDK generation, security, and completeness.
- **Detailed reports:** Access in-depth reports that highlight areas of
  improvement and provide recommendations.
- **Visualization:** Easily visualize the structure and quality of your API
  with in-line feedback.

### CLI

The CLI is perfect for developers who prefer the command line or need to
integrate quality checks into their development workflow. Run it instantly with
`npx rmoa` — no install required:

```bash
npx rmoa lint --filename <openapi-filename> --api-key <API_KEY>
```

Key features include:

- **Zero install:** Run via `npx rmoa` to always pick up the latest version.
- **Automated checks:** Integrate the CLI into your CI/CD pipeline for automated
  quality checks on every commit.
- **Detailed output:** Get detailed feedback directly in your terminal, with options
  to further integrate these results into your development flow.

See the [CLI page](./cli) for full usage.

### GitHub Action

Our GitHub Action seamlessly integrates with your repository to ensure your APIs
are consistently of high quality. Key features include:

- **Automated linting:** Automatically lint OpenAPI definition files on every
  pull request and push to ensure code quality.
- **Inline feedback:** Receive feedback directly in your pull requests with
  comments highlighting issues and areas for improvement.
- **Continuous improvement:** Maintain a high standard of API quality with
  continuous monitoring and feedback.