Serverovny.cz/Fórum/Jak udělat API verzi bez zrušení starých funkcí?

Jak udělat API verzi bez zrušení starých funkcí?

Zajímalo by mě, jak bych mohl vytvořit novou verzi API, aniž bych musel zrušit nebo odstranit ty stávající funkce, které uživatelé používají. Mám obavy, že když zavádím nové funkce a změny, mohli bychom tím narušit služby pro naše existující zákazníky a vývojáře, kteří už s naším API pracují. Je možné udělat takovou změnu bez toho, abychom způsobovali problémy těm, kdo dependují na starších verzích? Jaké jsou osvědčené postupy pro správu verzování API v těchto případech? Měl bych třeba implementovat nějaký systém pro správu verzí, který by umožnil uživatelům volit mezi různými verzemi? A co třeba takové „deprekování“ funkcí – jak to funguje v praxi? Dále mě zajímá, jestli je dobré mít nějaký časový rámec pro podporu starých verzí nebo zda je lepší se soustředit pouze na novinky a inovace. Narazil jsem na různé názory ohledně toho, jak dlouho by měly být starší verze dostupné. Jak tedy postupovat, abych zajistil hladký přechod na nové API bez zbytečných komplikací? Díky za jakékoli tipy a rady!

163 slov
1.6 minut čtení
22. 11. 2023
Vlastimil Chalupa

Jasně, dělat API verze bez zrušení starých funkcí je důležitý krok. Nejlepší je mít systém pro správu verzí, kde uživatelé můžou vybrat, kterou verzi chtějí používat. Třeba v URL můžeš mít něco jako /v1/ nebo /v2/ a tak dál. To dává lidem svobodu přejít na novou verzi, když budou připraveni.

Co se týče deprekování funkcí, tak to funguje tak, že uživatele upozorníš, že nějaká funkce bude zrušena v budoucnosti. Můžeš to třeba oznámit v dokumentaci a dát jim čas na přechod. Obvykle se doporučuje udržovat starší verze dostupné aspoň pár let, ale záleží na tom, kolik máš uživatelů a jak moc jsou na těch starých funkcích závislí.

Hlavně je důležitý mít dobrou komunikaci s uživateli, aby věděli, co se děje a jaké změny mohou očekávat. Takže klidně udělej roadmapu, kde bude jasně napsané, co plánuješ a kdy. Pak se můžeš soustředit na nový funkce, ale nezapomínej na ty starý – třeba čas od času udělej update nebo bugfixy pro starší verze. To pomůže udržet spokojenost u stávajících zákazníků.

166 slov
1.7 minut čtení
19. 1. 2025
Karel Novák

Takže, abys mohl udělat novou verzi API, aniž bys zrušil ty staré funkce, tak doporučuju využít verzování URL. Třeba můžeš mít něco jako /v1/ a /v2/. Uživatelé pak můžou přejít na novou verzi, ale starší verze zůstanou v chodu. Je fajn mít taky jasně daný plán deprekování – třeba oznamovat, že za rok už nebudeš podporovat v1, aby měli lidi čas se přizpůsobit. Co se týče podpory starších verzí, je dobrý mít nějaký časový rámec, protože ne všichni aktualizují hned. Někteří vývojáři chtějí mít stabilní verzi, na kterou se můžou spolehnout. Takže možná dva roky od vyřazení? Zkrátka, najdi rovnováhu mezi inovacemi a udržováním starých funkcí a všechno by mělo klapat.

112 slov
1.1 minut čtení
19. 1. 2025
Libor Světlík
Serverovny.cz/Články/API integrace
API Versioning: Jak správně spravovat změny v API bez narušení službyČlánek se zabývá důležitostí verzování API a technikami, které pomáhají provádět aktualizace plynule a bez problémů. Diskuze zahrnuje tipy pro úspěšné...
1000 slov
10 minut čtení
16. 4. 2023
Tomáš Březina
Přečíst článek
Podobné otázky