OpenAPI Validator
Check an OpenAPI 3.0, 3.1 or 3.2 or Swagger 2.0 document in YAML or JSON and get a summary of its endpoints and schemas. The validator checks the required fields, path templates against path parameters, parameter locations, response codes, duplicate operation IDs and every local $ref, and lists each problem with its location.
Frequently asked questions
What does the validator check?
It checks the openapi or swagger version, info.title and info.version, that paths start with a slash, that every {parameter} in a path has a matching required path parameter and the reverse, parameter names and locations, response status codes and descriptions, duplicate parameters, duplicate operationId values and that every local $ref points to something in the document.
Is this a full JSON Schema validation of the specification?
No. It checks the structural rules above, which catch most mistakes in hand-written documents, but it does not validate every field against the official meta-schema or check the content of your schemas.
What does the summary show?
The specification and API version, the title, a table of every endpoint with its method, path, operationId, summary and response codes, and the names of the schemas under components.schemas, or definitions in Swagger 2.0.
Are external references followed?
No. References to other files or URLs are not fetched and not reported. Only references that start with # are resolved inside the pasted document.
What is the difference between errors and warnings?
Errors break a rule of the specification, for example a missing response description or a path parameter that is not declared. Warnings point to things that are allowed but usually unintended, such as a GET operation with a request body or a document without any operationId.
Does OpenAPI 3.1 change what is required?
Yes. In OpenAPI 3.1 and 3.2 an operation no longer needs a responses object, and a document may have webhooks or components instead of paths. The validator applies those rules when the openapi field starts with 3.1 or 3.2.