API spec checker for OpenAPI
Upload your OpenAPI description and see what is wrong with it: every place with its path in the document, the defect, and what was read instead.
Free. All you need is an account.
What a result looks like
A public API description, as it is published, put through the checker once.
What it reports
The checker reads your document with the same reader the generator uses. Whatever it trips over, it writes down — in three kinds.
Error
Something is missing here, or imprecise: a reference that points at nothing, a placeholder in a path without a parameter.
Warning
The document breaks a rule here but can be read in one way only: a key in the wrong place, a type spelled the wrong way.
Note
The document is fine here, but leaves something open that a client has to decide for itself.
How a check runs
Upload
One file, JSON or YAML, up to 5 MB.
Read
The document waits in a queue for a moment and is then read in a process of its own. References to other hosts are not fetched.
Result
Up to 25 places of each kind, the rest as a number. The file is deleted once it is read, the result after 10 minutes.
What it is not
Not a verdict on the whole document. It reports what stands out while reading — an empty list does not mean your document is free of errors. What is said about each place is the reader’s own wording, in English. And very large documents do not fit into the time a check has.