API Contract Change Analyzer

Compare OpenAPI request and response changes, with explicit review findings for unsupported schemas and references.

On-device No sign-up Free to use

Compare API contracts controls

Showing an example. Edit to see your own.

Processed in your browser. Your inputs stay on this device.

Result

Showing an example.

Review supported OpenAPI request and response compatibility changes.

Removing GET /pets from the supplied OpenAPI 3.0.3 document produces one breaking finding: operation removed.

Loading the tool. Your result will appear here.

https://usefreetools.net/api-contract-change-analyzer · 20 November 2026

Was this helpful?

How to use API Contract Change Analyzer

  1. Paste before and after OpenAPI 3.0.x JSON documents.
  2. Run the comparison and read breaking, added, relaxed and review findings.
  3. Inspect unsupported references, composition and schema keywords separately.
  4. Export the change report and review affected clients before changing a server.

Example: API Contract Change Analyzer

Review supported OpenAPI request and response compatibility changes.

You add
Before OpenAPI 3.0.x JSON: {"openapi":"3.0.3","paths":{"/pets":{"get":{"responses":{"200":{"description":"OK"}}}}}} After OpenAPI 3.0.x JSON: {"openapi":"3.0.3","paths":{}}
You get
Removing GET /pets from the supplied OpenAPI 3.0.3 document produces one breaking finding: operation removed.

Supported inputs and limits

  • Up to 2 MiB, 30,000 JSON values, 40 nesting levels and 200 operations per document, with at most 5,000 findings.
  • Supports OpenAPI 3.0.x JSON;
  • Swagger 2, OpenAPI 3.1, YAML, reference expansion and composition evaluation are unsupported.
  • Checks cover operation/media/status removals, parameter and body requirements, property requirements and enum directions.
  • Bounds, types, nullability and security changes require review.
More details

No external reference is fetched.

A report without a breaking finding is not complete compatibility certification.

JSON numeric literals are limited to 128 characters and must retain their decimal value through browser Number conversion; integers outside the safe integer range and unsupported precision are refused.

Where your input is processed

This tool does not upload your inputs. See the limits for anything saved on your device.

Questions about API Contract Change Analyzer

Which compatibility direction is assumed?

The report considers an existing client calling an updated server. A newly required request field can break that client; a newly allowed response enum value can also require client changes.

Will a remote schema reference be downloaded?

References are reported as unexpanded and affected schemas need manual review. The tool makes no network request and does not follow even a local reference chain.

Does a clean report prove the APIs are compatible?

Only the documented subset is compared. Unsupported constructs, application behavior and generated-client assumptions still need separate review and tests.

Page updated · Project managed by Tony Hines · Report a problem with API Contract Change Analyzer