DEV Community

Cover image for Announcing RateMyOpenAPI!
Adrian Machado for Zuplo

Posted on • Originally published at zuplo.com

Announcing RateMyOpenAPI!

Today, we're announcing RateMyOpenAPI, an open-source tool to rate and fix your OpenAPI spec.

Why rate your OpenAPI spec?

OpenAPI is an industry standard to describe HTTP APIs in a machine-readable format, using either JSON or YAML.

When using OpenAPI in any project, you can leverage other tools to help you generate documentation, code, tests, mock results, or even deploy your API.

OpenAPI lifecycle

But even if you have a valid OpenAPI spec, it can fall short of being useful to the tools you want to use. For example, not describing the response body of an endpoint can make it impossible to generate a mock response for it.

RateMyOpenAPI helps you identify these issues and fix them.

How does it work?

In practice, you just upload your OpenAPI spec to the https://ratemyopenapi.com and it will give you a score and a list of issues to fix.

We have clustered the issues into the 4 categories, the two most important usages of OpenAPI: Documentation and SDK Generation; and two categories for general issues: Security and Completeness.

Powering RateMyOpenAPI is a set of linting rules that we have compiled from our experience working with OpenAPI and from the community.

RateMyOpenAPI screenshot

Try it out and contribute

RateMyOpenAPI is open-source and available on GitHub. We welcome contributions to the project, whether it's adding new rules or improving the existing ones - or even just giving us feedback on how to make it better.

If you have any questions, you can reach us on Discord, we'd be more than happy to chat!

Enjoy! 🎉

Do your career a big favor. Join DEV. (The website you're on right now)

It takes one minute, it's free, and is worth it for your career.

Get started

Community matters

Top comments (0)

Billboard image

The Next Generation Developer Platform

Coherence is the first Platform-as-a-Service you can control. Unlike "black-box" platforms that are opinionated about the infra you can deploy, Coherence is powered by CNC, the open-source IaC framework, which offers limitless customization.

Learn more

👋 Kindness is contagious

Explore a sea of insights with this enlightening post, highly esteemed within the nurturing DEV Community. Coders of all stripes are invited to participate and contribute to our shared knowledge.

Expressing gratitude with a simple "thank you" can make a big impact. Leave your thanks in the comments!

On DEV, exchanging ideas smooths our way and strengthens our community bonds. Found this useful? A quick note of thanks to the author can mean a lot.

Okay