OpenAPI Contract Inspector
An API contract breaks when path placeholders no longer match parameters or a component reference disappears. This browser-local inspector parses an OpenAPI document and checks a bounded set of path, reference, request and response rules. It also drafts a request for each operation. It does not certify full OpenAPI conformance.
Key features
- Parse OpenAPI 3.0.x/3.1.x JSON or YAML into paths and HTTP operations
- Check placeholders, required path parameters and duplicate parameters
- Find missing local JSON Pointer targets and alias-only reference cycles
- Show response code, description and body-schema findings by location
- Draft bounded request examples and save a JSON report
How to use
- Paste an OpenAPI 3.0 or 3.1 JSON/YAML description or choose a local file.
- Inspect JSON Pointer locations for errors and warnings.
- Select an HTTP method and path from the operation list.
- Review the drafted request and supply real authorization and values yourself.
- Edit the description, rerun the checks and save a report if useful.
Use cases
- Compare URL placeholders with required path parameters
- Find broken local references after a component rename
- Review response descriptions and JSON body-schema gaps
- Share an operation inventory and request draft during review
Frequently asked questions
Which OpenAPI versions are inspected?
The common core of OpenAPI 3.0.x and 3.1.x. It parses JSON/YAML and checks selected path, parameter, reference, request and response rules. It does not certify every specification rule, JSON Schema vocabulary or security requirement.
Are external $ref targets fetched?
No. Only #/… JSON Pointers in the current document are resolved. External URLs and files are marked as warnings and never fetched, so an external reference leaves the contract only partially inspected.
Is a recursive schema invalid?
An object schema referring to itself through a property is allowed. Only alias-only chains of $ref objects with no terminating value are reported as cycles.
Can I send the generated request unchanged?
No. It is a bounded draft using required fields and basic types. It does not complete oneOf choices, every serialization style, authentication, server variables or business rules, and it never sends a request.
Is a missing content schema always an invalid response?
No. This is a warning that body constraints cannot be inspected. A response without content, such as 204, is not warned about.
Privacy
The pasted or selected API description stays in current browser memory. External references are never fetched and no request is sent to an API server. A report you explicitly save contains path and diagnostic information.
Comments & questions