Změny API

Nekompatibilní změny, zastarávání a verzování, vysvětlené lidem, kterých se týkají.

Verzování API Stripe: jak funguje a co z něj převzít

Verzování API Stripe připíná každý účet k datované verzi a každý požadavek ji může přepsat. Jak funguje, co stojí a co z něj může převzít malé API.

Změny API2. 10. 20266 min čtení
Breaking changes v Protobuf: co přežije na drátě

Breaking changes v Protobuf vznikají na drátě, ne v URL. Některé změny polí v gRPC jsou zdarma, jiné potichu rozbijí klienty, a v diffu vypadají stejně.

Změny API22. 9. 20265 min čtení
Deprekace GraphQL bez čísla verze

GraphQL nemá v1 nebo v2 v URL. Pole se deprekují jedno po druhém direktivou, na schématu sdíleném všemi klienty, což mění, co dluží changelog.

Změny API17. 9. 20265 min čtení
Jak napsat migrační průvodce API

Migrační průvodce API mění nekompatibilní změnu ve checklist místo výpadku. Co potřebuje, kdy ho zveřejnit, a proč samotný záznam changelogu nestačí.

Změny API7. 9. 20264 min čtení
Interní API changelogy: co se mění pro druhý tým

Veřejný API changelog má publikum, které nelze kontaktovat přímo. Interní má publikum o dvě patra dál, a to mění, co mu changelog vlastně dluží.

Změny API7. 9. 20264 min čtení
Hlavička API Sunset a kdy ji odeslat

Hlavička API Sunset říká klientovi, kdy verze přestane odpovídat, na rozdíl od oznámení o deprekaci. Co pokrývá RFC 8594 a co přináší brownout před koncem.

Změny API7. 9. 20264 min čtení
Changelogy webhooků: breaking change, o kterou nikdo nežádal

Změna payloadu webhooku se rozbije potichu, protože ji nemá kdo odmítnout. Co dělá změnu payloadu breaking a jak ji krok za krokem verzovat.

Změny API7. 9. 20265 min čtení
API changelog: co publikovat a kdo to čte

API changelog čtou lidé, kteří rozhodují, jestli jejich kód bude fungovat i příští měsíc. Co dluží každý záznam jim, kde má být, a jak se dá odebírat.

Změny API2. 9. 20266 min čtení
Jak deprekovat API bez ztráty vývojářů

Deprekace je slib s datem. Harmonogram, šablona oznámení, hlavičky odpovědi, a krok, který brání sunsetu stát se incidentem podpory pro celý tým.

Změny API29. 8. 20265 min čtení
Nejlepší praktiky verzování API, kvůli volajícím

Verzujte jen to, co rozbíjí kompatibilitu, umístěte verzi tam, kde ji volající vidí, a starou udržujte funkční do data. Čtyři schémata porovnaná.

Změny API29. 8. 20266 min čtení
Breaking changes: co se počítá a jak je vydat

Breaking change je každá změna, kterou by korektní volající nepřežil. Co se počítá, co ne, jak ji zachytit v CI a jak ji bezpečně vydat svým uživatelům.

Změny API29. 8. 20268 min čtení