Skip to content

Learn OpenAPI by example

One question per page. Each answer comes with an example that validates and the output of the tools that read it, and says when it was last checked.

OpenAPI reference

One keyword or pattern per page: what it means, an example that validates, and what tools do with it.

Errors and fixes

The message a linter, validator or mock server prints, the spec that causes it, and the fix.

Guides

Tasks from start to finish: checks in CI, migrations, publishing.

Choosing a tool

Sourced comparisons of the tools that edit, document and mock an API description, row by row.

Try it with your own API

Create a free workspace, add an OpenAPI file, and publish its documentation and a mock server from the same repository.

Free for individuals. No credit card.

$ npm install -g @apigit/cli$ apigit auth login$ apigit doc publish