Verzování
API používá verzování přímo v URL:
http
GET /api/v1/Client/Simple- budoucí major verze mohou běžet paralelně (např.
/api/v1/...a/api/v2/...)
Kompatibilita
V rámci jedné major verze (např. v1) se zavazujeme nenarušit zpětnou kompatibilitu:
- Nové volitelné parametry mohou přibýt
- Nové pole v odpovědi mohou přibýt
- Existující pole v odpovědi se neodebírají ani nemění typ
Doporučení
- Mějte verzi API v konfiguraci, ne napevno v URL.
- Při přechodu na novou major verzi plánujte přechodné období.
Zastaralé endpointy
- Starší endpointy mohou být označené v dokumentaci a ve Swagger UI jako zastaralé před jejich úplným odstraněním.
- Před zrušením endpointu bude k dispozici přechodné období, kdy bude fungovat jak stará, tak nová verze (pokud je to možné), aby se usnadnil přechod.
- Odstranění endpointu bude provedeno pouze v případě, že je to nezbytné (např. bezpečnostní důvody, výrazné zlepšení výkonu) a vždy s dostatečným předstihem.
Praktické doporučení
- Sledujte oznámení na webu nebo e-mailu
- Při zveřejnění nové verze si připravte migrační plán
- Neodkládejte přechod na novější verzi