API & OpenAPI utility

OpenAPI Schema Diff

Compare named component schemas between two OpenAPI documents.

● This tool runs entirely in your browser. Your input is never uploaded to our servers.

OpenAPI YAML or JSON

Output

Your result will appear here…

How to use OpenAPI Schema Diff

Paste the baseline specification, then === TARGET ===, then the target specification.
Select Compare Schemas to list added, removed, and changed component schemas.
Inspect field-level changes before deciding whether they are compatible.

Example

Input:

{"openapi":"3.0.3","info":{"title":"Demo","version":"1"},"paths":{},"components":{"schemas":{"User":{"type":"object","properties":{"id":{"type":"integer"}}}}}}
=== TARGET ===
{"openapi":"3.0.3","info":{"title":"Demo","version":"2"},"paths":{},"components":{"schemas":{"User":{"type":"object","properties":{"id":{"type":"string"}}},"Team":{"type":"object"}}}}

Output:

Changed schema: User
Added schema: Team

Use cases

Review model changes between API versions.
Find removed or added component schemas.
Focus an API review on schema definitions.

About this tool

Compare named component schemas between two OpenAPI documents. Processing happens locally in your browser, so your input is not sent to a server or included in analytics.

Frequently asked questions

Does this compare every nested field individually?

It reports which named schemas differ; it does not explain every field-level change.

How do I separate both documents?

Place === TARGET === on its own line between the two YAML or JSON documents.

Does it resolve references?

No. References are compared as part of the schema text structure and not expanded.