API Versioning strategie

Jak verzovat REST API bez rozbití klientů. URL, header a query parameter versioning.

Přístupy

# URL Path (nejčastější)
GET /api/v1/users/123
GET /api/v2/users/123

# Header
GET /api/users/123
Accept: application/vnd.myapi.v2+json

# Query Parameter
GET /api/users/123?version=2

Breaking vs Non-breaking

Breaking: Odebrání pole, změna typu, přidání povinného parametru.

Non-breaking: Přidání nepovinného pole, nový endpoint, nový nepovinný parametr.

Shrnutí

Verzujte od začátku. Preferujte additive changes. Starou verzi udržujte po přechodné období.