Jak rozchodit své první REST API a neztratit se v odpovědích
Autres actions
Prakticky to vypadá tak, že si připravíte nástroj pro odesílání požadavků. Můžete použít terminál s nástrojem curl, nebo specializovaný klient, který vám umožní nastavit hlavičky, parametry i tělo požadavku. Nezapomeňte, že každá adresa API se skládá z takzvaného endpointu, což je konkrétní cesta ke zdroji. Například pokud chcete získat seznam uživatelů, pošlete GET na adresu, která končí na /users. Když potřebujete konkrétního uživatele, přidáte identifikátor: /users/123. Většinou také narazíte na parametr pro stránkování, který se předává buď v adrese, nebo v hlavičce. Pokud API vrací velké objemy dat, bez stránkování se neobejdete a měli byste si na to rovnou nastavit testovací scénář.
Prvním krokem je diagnostika. Sedněte si do židle tak, jak to děláte běžně, a položte dlaň mezi spodní část zad a opěradlo. Pokud dlaň projde bez odporu, znamená to, že bederní opěrka buď vůbec nesedí, nebo je příliš vysoko. Další test spočívá v tom, že se zapřete rukama o sedák a nadlehčíte se. Když sedák zůstane prohnutý i po několika vteřinách, je pěna unavená a ztratila pružnost. Třetí varovný signál je vrzání nebo kývání opěradla při změně polohy – to obvykle ukazuje na povolený šroub nebo opotřebovaný plynový píst.
Další pastí je špatné nastavení hlaviček. Obsahový typ (Content-Type) by měl odpovídat tomu, co posíláte, tedy application/json, pokud neposíláte něco jiného. Bez něj server nemusí správně přečíst tělo požadavku. Podobně důležité je nastavit hlavičku Accept, která říká, jaký formát odpovědi chcete přijmout. Pokud chcete JSON, pošlete Accept: application/json. Mnoho API vyžaduje také autorizační hlavičku, obvykle ve formátu Bearer token. Když ji vynecháte, dostanete 401 a nebudete vědět proč. Pro otestování si proto vždy zkuste požadavek nejdřív v klientovi a teprve potom ho implementujte do kódu.
Než začnete cokoli opravovat, zkontrolujte také všechny šrouby a spoje. Povolená opěradla a područky se dají utáhnout běžným imbusovým klíčem, který bývá součástí balení. Pokud židle vrzá, naneste na pohyblivé části tenkou vrstvu silikonového spreje – nikdy nepoužívejte olej na rostlinné bázi, ten přitahuje prach a zhorší problém. Pamatujte, že i kvalitní sedačka má životnost zhruba deset let; po této době je lepší investovat do nové, než riskovat dlouhodobé poškození páteře.
Když začínáte s REST API, první otázka obvykle zní, odkud vůbec vzít data. V praxi to znamená, že pošlete HTTP požadavek na adresu, která reprezentuje zdroj, a server vrátí odpověď. Než ale začnete psát první řádky kódu, ujasněte si, co od API očekáváte: potřebujete data číst, vytvářet nové záznamy, nebo je měnit? Od toho se odvíjí volba metody, kterou použijete. Pro čtení se hodí metoda GET, pro vytvoření nového zdroje POST, pro úpravu PUT nebo PATCH a pro smazání DELETE. Většina moderních API používá formát JSON, ale setkáte se i s XML. Právě JSON je dnes standardem, protože je lehce čitelný a snadno se zpracovává v JavaScriptu i v jiných jazycích.
Samotné zpracování odpovědi v kódu má také svá úskalí. Pokud používáte jazyk, který má asynchronní zpracování, nezapomeňte, že odpověď nepřichází okamžitě. Musíte počkat na dokončení požadavku a teprve poté s daty pracovat. Většina jazyků má pro to vestavěné mechanismy, jako jsou async/await v JavaScriptu nebo C#, či futures v Pythonu. Nikdy neblokujte hlavní vlákno a nepište kód, který čeká na odpověď synchronně, pokud to není nezbytně nutné. Tím se vyhnete zamrznutí aplikace a uživatelé nebudou čekat.
Na závěr si osvojte návyk, že si vždy přečtete dokumentaci daného API. I když je lákavé spustit požadavek hned, dokumentace vás upozorní na limity, omezení a specifické chování. Například kolik požadavků za minutu smíte poslat, jaké parametry jsou povinné a jaká je maximální délka odpovědi. Bez toho snadno narazíte na to, že vám API začne vracet chyby o překročení limitu, a vy budete muset zpomalit. Také se naučte číst chybové hlášky, které API vrací – často obsahují přesný důvod, proč požadavek selhal. Když si na toto všechno dáte pozor, první REST API pro vás bude sice výzva, ale zvládnete ji bez zbytečných zádrhelů.
Zimní měsíce jsou pro chovatele slepic zatěžkávací zkouškou. Nejde jen o to, aby ptáci nezmrzli, ale také o to, aby si zachovali dostatek energie pro snášku a odolnost vůči nemocem. Základem je vzduchotěsná, ale dobře větraná stavba. Průvan je totiž větším nepřítelem než mráz. Pokud do kurníku táhne, slepice často nastydnou, přestanou snášet a mohou si i poškodit dýchací cesty. Zkontrolujte proto všechny spáry, utěsněte je silikonem nebo vhodnou těsnicí páskou, ale ponechte funkční větrací otvor u stropu, který umožní odvod vlhkosti.