OPENAPI GUIDES

Make API compatibility automatic

Practical explanations and tools for detecting breaking OpenAPI changes before they reach consumers.

01

Compare OpenAPI specifications before you merge

Compare OpenAPI YAML or JSON files for breaking API changes, then automate the same check on every GitHub pull request.

02

Find breaking Swagger changes without reading raw YAML

Diff Swagger and OpenAPI contracts for breaking endpoint, parameter, response and schema changes.

03

Put API compatibility inside every pull request

Install an OpenAPI GitHub App that detects breaking API contract changes and reports them as pull-request checks.

04

Recognise API changes that break real consumers

Practical examples of breaking REST API and OpenAPI changes, including removed responses, required parameters and schema changes.

05

Check OpenAPI schemas for backward compatibility

Check OpenAPI request and response schemas for backward-incompatible type, property and requirement changes.

06

Add an OpenAPI compatibility gate to CI

Add automatic OpenAPI backward-compatibility checks to GitHub pull requests without maintaining a custom CI script.