OpenAPI breaking-change diff
Compare two OpenAPI 3 documents and list breaking and non-breaking API changes.
Runs in your browser. Your input is not uploaded.
Loading the tool…
What it does, how to use it, and questions
What it does
An OpenAPI 3 document describes paths, methods, request bodies and responses. Comparing two versions catches removals and newly required fields before clients break.
Both sides may be JSON or YAML. The check focuses on paths, methods, status codes and JSON request schemas.
How to use it
- Paste the old spec on the left and the new spec on the right.
- Read Breaking and Non-breaking lists.
- Fix the breaks or document them before release.
Things to watch for
- Changes only inside
componentswithout inlined request schemas may be under-reported. - Removing an optional property is treated as breaking for clients that still send it in strict modes.
Questions
- Is OpenAPI 2 / Swagger supported?
- No. Convert to OpenAPI 3 first.
- What counts as breaking?
- Removed paths or methods, removed response codes, newly required properties, removed properties, type changes and removed enum values.
- Are $ref links followed?
- Only schemas already present under request content are compared. Deep component graphs are not fully expanded.
- Is either spec uploaded?
- No. Both are compared in this page.