Versioning
API Contract Versioning: How to Avoid Breaking Integrations
How to record a compatibility promise with SemVer, OpenAPI document versions, and URL or media-type signals, without pretending one of them is required by HTTP.
Tag
compatibility
Notes tagged compatibility.
-
-
Contracts
Backward Compatibility in APIs: Fields, Enums, and Behavioral Changes
How to tell a compatible API change from a breaking one, using JSON Schema keywords and Google's AIP-180 as a published guide rather than a universal law.
-
Testing
Contract Testing vs Integration Testing: Where Each One Fits
How Pact defines a contract test, how that differs from schema validation and from a joined integration run, and which bugs each one can and cannot show.
-
Contracts
How to Migrate an API Contract Without Breaking Existing Clients
A three-phase sequence, expand then migrate then contract, for changing an API contract while old clients keep working, with rollback called out as its own case.
-
Webhooks
Webhook Payload Design: Structure, Versioning, and Reliability
How to shape a webhook payload using CloudEvents and the Standard Webhooks specification, including identity, signatures, duplicates, and retries.