OctaSapien

Interface Compatibility Diff Analyzer

FREE
More actions

Found something we could improve?
Practical usage guide

Practical usage guide

A practical workflow for Interface Diff Analyzer

Compare OpenAPI JSON, WSDL and XSD versions locally to detect breaking interface changes, integration risks and regression tests before transport.

1. Prepare

Provide baseline and candidate contracts in the same supported format: OpenAPI, WSDL or XSD. Example: remove GET /orders from an OpenAPI candidate.

2. Review

Review classified findings and source references. The removed operation is reported as breaking with operation_removed and GET /orders as evidence.

3. Apply

Coverage is limited to supported contract rules. Findings do not prove universal compatibility or execute consumers; confirm runtime behavior and consumer-specific dependencies.

Verification before operational use

  • Use a representative case with the inputs needed to reproduce it.
  • Confirm the result in the authorized target environment when runtime versions, namespaces, extensions, permissions or system configuration can change the outcome.
  • Record the source, assumptions, tool settings and expected result so another reviewer can reproduce the check and distinguish verified facts from recommendations.