DEVELOPER TOOLS
OpenAPI / Swagger Inspector
Inspect OpenAPI 3.0 and 3.1 JSON or YAML for common structural issues, endpoint operations, and local references.
LOCAL STRUCTURAL CHECK
Inspect an API definition
Your definition is parsed in this browser. This is a focused structural check, not complete official OpenAPI conformance. External $ref targets are never fetched and will be reported as unresolved.
Paste the complete document. Input limit: 500,000 characters. No API calls or external reference requests are made.
Inspection result
OpenAPI version:
Errors
- :
Warnings
- :
Notes
- :
Endpoints
No HTTP operations were found.
-
— :
The pasted definition is processed locally. It is not uploaded, and this tool does not call the described API.
OpenAPI and Swagger inspector guide
An OpenAPI document describes an HTTP API: its paths, operations, parameters, request bodies, responses, and reusable components. This inspector reads JSON or YAML locally, summarizes the endpoints it can recognize, and reports useful structural problems before you hand the specification to a downstream tool.
The report is a focused review aid, not a promise that every OpenAPI rule or vendor extension is valid. Treat diagnostics as a checklist, then validate the finished document with the exact gateway, SDK generator, or contract-testing system that will consume it.
Read the endpoint inventory
Start with the document information and the endpoint table. Each recognized path and HTTP method represents an operation; operation IDs help generated clients give those operations stable names. Duplicate IDs, malformed path entries, missing summary information, or an incomplete top-level structure can make a file harder to review or generate from.
A path can contain several methods, and a path item can inherit parameters or describe server behavior. Use the inventory as a navigation aid rather than a complete execution plan: it does not send requests, discover hidden routes, or prove that the deployed service behaves as the document claims.
Understand local and external references
OpenAPI documents commonly reuse schemas and parameters through JSON Pointer references such as #/components/schemas/Order. The inspector resolves local pointers within the pasted document and can flag references that point nowhere. Escaped pointer segments such as ~1 for a slash and ~0 for a tilde matter when names contain those characters.
External references are deliberately not fetched. A URL-shaped $ref may depend on another file or a private registry, so the report warns that it remains unresolved instead of making a network request or implying that the linked content was checked. Supply a complete local bundle or use your organization’s trusted resolver when external files are part of the contract.
Use structural diagnostics in context
This browser check focuses on OpenAPI 3.0 and 3.1 document structure, endpoint shape, unique operation identifiers, and local reference targets. It is not the full official schema validator: advanced constraint interactions, custom extensions, security policy, server reachability, generated-client compatibility, and runtime behavior require separate review.
Keep a known-good specification under version control and compare changes before publishing. For a release, run a standards-aware validator and a contract test against the intended service; check authentication and error responses as well as the happy path. Your pasted document stays in this browser.
Frequently asked questions
Does this call the API described by the document?
No. It inspects the pasted specification locally and does not send requests to any API server.
Are external $ref files downloaded?
No. Only local references inside the pasted document are resolved; external references are reported as unresolved and must be checked separately.
Does a clean report prove full OpenAPI conformance?
No. The inspector performs focused structural checks, not a complete implementation of every OpenAPI rule or vendor extension.
Can I paste YAML as well as JSON?
Yes. JSON and YAML are parsed in your browser; malformed syntax is reported before the document checks run.
Privacy note: this tool processes your data in your browser. Your inputs and files are not submitted to NAB Tools.