API comparison workflow
Compare API responses for breaking changes
A useful comparison separates structural changes from ordinary value changes and produces paths developers can act on.
Compare equivalent responses
Use responses from the same endpoint and scenario so the report reflects meaningful change.
Capture the baseline
Remove request-specific secrets and preserve the expected response.
Add the changed response
Use the same endpoint, parameters, and fixture where possible.
Review structural differences
Prioritize removed fields and changed data types.
Export the report
Share the path-based difference report with the development team.
The three kinds of change to look for
- Added fields that your code does not expect
- Removed fields that your code relies on
- Changed values or types in shared fields
Compare two responses in minutes
- 1
Paste the first response into the API response diff.
- 2
Paste the second response and run the comparison.
- 3
Review the added, removed, and changed sections of the report.
- 4
Fix your integration for the changes before deploying.
Noise in API comparison
- Timestamps change on every request
- Array order can create misleading differences
- Generated identifiers are unstable
- Optional fields may appear only in certain scenarios
Reduce false positives
- Use stable test fixtures
- Normalize timestamps when appropriate
- Compare schema as well as values
- Redact tokens before sharing reports
Frequently asked questions
Does the diff show value changes or only structure?
Both. The report lists added and removed fields plus changed values and types, so schema drift and data drift are visible.
Can I compare responses of different sizes?
Yes. The diff aligns matching paths where possible and lists unmatched sections separately.
Is this the same as the JSON diff tool?
The workflow is the same; the response-focused page guides you through the API-specific checks such as headers and status handling.
Are my responses stored?
No. Both responses are compared locally in your browser.
Keep response bodies on the device
The response comparison runs locally. Sensitive API values should still be redacted before screen sharing or downloading reports.
Open API Response Diff