Pattern 39 / EDGE

API Versioning

Use this when evolving an API without breaking existing clients.

Pressure
Evolving an api without breaking existing clients
Mechanism
Support multiple contract versions through url, header, or media-type negotiation
Toll
Old versions create maintenance burden and migration planning
Architecture plate39
Diagram for API Versioning
Executive brief

API Versioning fits when evolving an API without breaking existing clients. Mechanism: support multiple contract versions through URL, header, or media-type negotiation. Use it for public APIs and internal APIs with many independent consumers. The toll: old versions create maintenance burden and migration planning.

Use when

Public apis and internal apis with many independent consumers.

Example

/v1/orders remains while /v2/orders adds fields and semantics.

Review framing

Describe the pressure first, then the mechanism, then the cost. That keeps the design grounded.

Same pressure family

API Design Patterns

35API Gateway36Backend for Frontend (BFF)37Rate Limiting38Pagination (Cursor-Based)
โ† 3840 โ†’