OpenAPI Diff Checker

Compare path operations between two OpenAPI specs.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

Sample inputs
Specs
Before OpenAPI JSON:
{"openapi":"3.1.0","paths":{"/users":{"get":{"summary":"List users"}}}}
After OpenAPI JSON:
{"openapi":"3.1.0","paths":{"/users":{"get":{"summary":"List users"}},"/invoices":{"get":{"summary":"List invoices"}}}}

Generated result
Summary: 1 old operation compared with 2 new. 1 note.

Stats
- Before Operations: 1
- After Operations: 2
- Removed: 0
- Added: 1

Issues
- Note: Added operation: GET /invoices

Output
Removed operations:

Added operations:
- GET /invoices

• Two JSON specs

  Before and after OpenAPI documents must be separated so each can be parsed independently.

• Operation inventory

  HTTP methods under paths are collected as operation keys such as GET /users.

• Removed operations

  Operations present in the old spec but missing from the new spec are reported as breaking-risk errors.

• Added operations

  New operations are reported separately as informational changes.

• Scope of diff

  The current implementation compares operation presence, not every parameter, schema, or response-body change.