5 návyků, díky nimž API přežije změny datového modelu

Z Mazovia

Nakonec pište kontrakt jako dokument, který je součástí kódu, a testujte ho proti uloženým ukázkám odpovědí. Když se model změní, test odhalí, co se rozbilo dřív než klient. Rozhraní navržené s ohledem na budoucnost není to, které předpoví všechny změny — je to takové, u kterého změna neznamená přepsání všech volajících.

Kontejner není miniaturní virtuální stroj. Je to izolovaný proces, který sdílí jádro hostitelského systému. Z toho plyne první praktický důsledek: v kontejneru neběží vlastní init, nečekejte systemd ani služby nastartované při bootu. Pokud aplikace potřebuje něco spustit na pozadí, musí to zařídit sama nebo přes jednoduchý supervisor. Kdo tohle neví, stráví hodiny laděním, proč kontejner hned skončil — obvykle proto, že jeho hlavní proces doběhl a kontejner nemá co dělat.

Pro vztahy používejte odkazy a rozšiřujte je explicitně. Místo vnořování celých objektů vracejte identifikátor a nabídněte parametr pro rozšíření příbuzných dat. Když se později vztah změní z jednoho nábytek na míru mnoho, rozšíření se upraví, ale základní odpověď zůstane stabilní. U výčtových hodnot počítejte s neznámou hodnotou na straně klienta a nikdy ji nevyhazujte jako chybu.

Verzování řešte dřív, než ho budete potřebovat Verzi nedávejte do cesty, pokud to není nutné, ale mějte připravený mechanismus. Kompatibilní změny – přidání volitelného pole, nová hodnota výčtu, nový koncový bod – se dají dělat přímo. změny, jako je odebrání pole nebo změna typu, potřebují novou verzi nebo souběžnou existenci obou podob. Typická chyba je měnit význam existujícího pole: klient, který posílá hodnotu v metrech, ji najednou pošle v centimetrech a nikdo si toho nevšimne. Význam pole se nesmí měnit; místo toho přidejte pole nové a staré označte za zastaralé s jasným datem konce.

Na závěr testujte chování zařízení, ne jen aplikace. Odeberte oprávnění k síti, ukončete proces na pozadí, restartujte telefon, nechte baterii přejít do úsporného režimu. Sledujte, zda se synchronizace obnoví sama a zda uživatel vidí, co se děje. Dobrý testovací scénář vždy obsahuje stav před výpadkem, průběh výpadku a stav po obnovení — a u každého výslovně kontrolujte, co vidí uživatel a co je skutečně uložené.

Verzování řešte na úrovni kontraktu, ne adresy Verze v cestě je snadná, ale drahá: nutí vás udržovat dvě větve logiky a klienty k hromadnému přechodu. Často stačí aditivní vývoj — nová pole jsou nepovinná, stará zůstávají, odstranění probíhá v několika fázích. Nejdřív pole označíte jako zastaralé, pak přestanete hodnotu vracet, a teprve potom ho z kontraktu odstraníte. Zlomovou změnu si nechte na situace, kdy se skutečně mění význam dat, ne jen jejich obal.

Na co si dát pozor: analytická fáze má tendenci bobtnat, pokud není jasně definovaný výstup. Typická chyba je odhadovat analýzu jako „půl dne" bez ohledu na složitost domény. U implementace zase hrozí, že se do odhadu započítá i čekání na odpovědi od byznysu. Řešení je jednoduché: do odhadu analýzy zahrňte pouze aktivní práci analytika, ne čekání. Do odhadu implementace naopak nezahrnujte nejistotu z neznalosti zadání – ta patří do analytické části. Pokud se během implementace objeví nové otázky, znamená to, že analýza nebyla dokončená, a tým by měl tento problém řešit, ne ho maskovat delším odhadem.

Ptejte se i vy. Zajistěte si, s kým budete pracovat, kdo bude váš mentor, jak probíhá code review a jestli má tým nastavené testy a verzování. Odpovědi na tyhle otázky řeknou o budoucí práci víc než popis firemní kultury. Pokud firma nemá nikoho, kdo by juniora vedl, první měsíce budou boj a vy se můžete naučit špatné návyky. Není to automaticky důvod odmítnout, ale musíte o tom vědět předem.

Na závěr: navrhujte API podle toho, co klient potřebuje, ne podle toho, jak je databáze postavená dnes. Držte stabilní identifikátory, neměňte význam polí, připravte verzování a testujte staré klienty proti novému rozhraní. Tím se změna modelu stane rutinou místo odstávky.

Data neukládejte do zapisovatelné vrstvy kontejneru. Ta zmizí spolu s kontejnerem a při rekreaci o ni přijdete. Pro trvalá data používejte volume nebo bind mount. U vývoje se osvědčuje namountovat zdrojový adresář a nechat aplikaci načítat změny, u produkce naopak data oddělit do pojmenovaného volume. A ještě jedna věc: kontejner neposlouchejte na 127.0.0.1, pokud ho chcete mít dostupný zvenčí. Uvnitř kontejneru to znamená jen jeho vlastní loopback, takže port nebude dosažitelný ani po mapování.

Na závěr si zvykněte dívat se na logy a stav procesu dřív, než začnete cokoli přestavovat. docker logs a docker inspect řeknou víc než hodiny hádání. Většina problémů začátečníka má stejný kořen: očekávání, že se kontejner chová jako server, místo aby se choval jako proces, který má svůj jasný vstup a výstup.