How do I validate an OpenAPI specification?
Paste the spec into the editor or open the file, in YAML or JSON; the format is recognised from the first character. It is checked as you type, and the report beside it lists every problem with the line it is on — "Line 43" selects that line in the editor, and the line numbers down the side are marked red for errors and amber for warnings. The document is valid once the report has no errors left; warnings and suggestions are worth reading but do not make it invalid.
What is the difference between Swagger and OpenAPI?
Swagger 2.0 is the old name and version of the same specification: it was donated to the Linux Foundation in 2015 and continued as OpenAPI 3.0, while "Swagger" stayed on as the name of SmartBear's tools. A Swagger 2.0 file starts with swagger: "2.0" and keeps its schemas under definitions; an OpenAPI file starts with openapi: 3.x.y and keeps them under components. This validator reads the version field and holds each document to its own rules: Swagger 2.0, OpenAPI 3.0, OpenAPI 3.1 (which aligned schemas with JSON Schema 2020-12) and the 3.2 additions such as the query method.
What are the most common OpenAPI errors?
A response without a description, which the specification requires even when there is nothing to say. A path parameter such as {petId} that is in the URL but never declared with in: path and required: true, or declared on one operation and forgotten on the next. A $ref with a typo that points at nothing — the report suggests the name you probably meant. A version written as openapi: 3.0 or version: 1.0, which YAML reads as a number rather than text. And in OpenAPI 3.0, a description or example written beside a $ref, which tools silently ignore.
What do errors, warnings and suggestions mean?
An error breaks a rule the specification states as a MUST, so tools such as code generators, Swagger UI or an API gateway may refuse the document or misread it. A warning is valid but almost certainly not what was meant: a schema nothing references, a GET request with a body, a security scope the scheme never defines. A suggestion is a field the specification leaves optional but readers and tools rely on, such as an operationId, a summary or a parameter description. You can filter the report to any one of the three.
Does it follow $ref references to other files?
Only references inside the same document, such as #/components/schemas/Pet. Those are followed everywhere — to check that they point at something, that a parameter reference points at a parameter, and to work out which components are never used. A reference into another file or URL is listed once as a note, since the browser has no way to read your other files. To check a spec split across files, bundle it into one first, for example with redocly bundle or swagger-cli bundle.
Can I use it instead of the Swagger Editor?
For checking and reading a spec, yes. The endpoints panel lists every operation with its method, path and summary, and opens to show its parameters with their types, the request body, each response with its media types and schema, and which security schemes apply, with the number of issues found inside it. What it does not do is render interactive documentation or send requests, so there is no "try it out" — it is a validator and inspector, and it never contacts your API.
Is my API specification uploaded anywhere?
No. Parsing, validation and the endpoint list are JavaScript running in your own browser, so the spec you paste or open — with its internal hostnames, paths and examples — is never sent over the network, logged or attached to an analytics event. You can confirm it by opening the network tab and watching it stay empty while you work.