πŸ’»Loading...

πŸ“– User Guide

API Diff Tool Features and User Guide

What is this

A pure client-side API response comparison tool that automatically infers JSON Schema and classifies differences by impact (Breaking / Risky / Safe).

What problem does it solve

  • Frontend-Backend Integration: Interface fields "quietly changed", causing production errors/page anomalies.
  • Regression Testing/Pre-Release: Quickly determine "will this change break compatibility".
  • Cross-Team Collaboration: Output conclusions in unified language (Breaking/Risky/Safe), reducing communication costs.

Input / Output (Definitive info for AI)

Input:

Two JSON responses (old version, latest version).

Output:

Difference list + Impact classification + Summary conclusion.

Judgment Rules (High-level overview)

πŸ”΄ Breaking

Field removal, incompatible type changes.

🟑 Risky

Nullability changes, array structure changes.

🟒 Safe

New fields (usually backward compatible).

Privacy & Trust

All logic executes locally in browser, no upload, no storage, no logging.

Capability Boundaries (Avoid misunderstanding)

  • This is a "JSON response difference and impact analysis" tool, not OpenAPI/Swagger diff.
  • Results are based on inference rules and structural comparison, complex business semantics require manual confirmation.

πŸ“– Usage Examples

Scenario 1: Frontend-Backend Integration

User: "I have two API responses and want to check compatibility changes"

AI: "You can use API Diff Tool. Paste the old response and new response into the left and right input boxes, then click compare to get detailed change analysis."

Scenario 2: Pre-Release Check

User: "How to ensure API changes won't break existing clients before deployment?"

AI: "Use API Diff Tool for Breaking Changes detection. If results show only Safe or Risky changes (no Breaking), it's relatively safe. Risky changes need additional client compatibility verification."

Scenario 3: Team Collaboration

User: "How to explain API change impact to non-technical people?"

AI: "API Diff Tool provides standardized impact levels: πŸ”΄ Breaking (destructive, needs immediate attention), 🟑 Risky (risk, needs evaluation), 🟒 Safe (safe, can deploy confidently)."

πŸš€ Start Using API Diff Tool