Why should I care about OpenAPI?

Open API is the de-facto choice for designing and documenting REST APIs. Following an API First123 strategy allows teams to design and define, test, mock and explore APIs without building any code.

It allows service providers and consumers to work independently, using a strongly defined, rich API contract.

Why do I need an OpenAPI linter?

We are human and we suck at writing. Even when something looks syntactically correct, it will probably still read like garbage.

There are more than likely missing examples, poor descriptions, invalid mis-matched version syntax and all kinds of other syntax issues.

Without a linter, you have no idea if your contract is high quality.

Why should I use this one?

After architecting and leading multiple company wide initiatives over multiple years to solve OpenAPI quality problems at a tech mega-corporation, no linter operated at the scale and speed we required.

Linting was the slowest, clunkiest and the most painful part of processing OpenAPI specifications at scale. All the tools were/are still built in TypeScript, which is great - if you like going slow.

vacuum solves all these problems, completely.

Why build this?

I personally really care about this. I am not happy with the tools on the market, and they do not work in the way I want to consume them. vacuum is designed to be experience first.