5 kroků, jak proběhne první REST API a co ho zdrží
페이지 정보
본문
Bez správného světla je sebelepší uspořádání k ničemu. Lampu umístěte tak, aby světlo dopadalo na stránku z boku nebo zezadu, ne přímo do očí. Pokud má stolek pevnou desku, zvažte lampu s kloubovým ramenem, kterou nastavíte přesně nad knihu. Teplé světlo kolem 2700 až 3000 K je pro večerní čtení vhodnější než studené bílé, protože méně ruší přirozený útlum před spaním. Další častá chyba: lampa stojí za vámi a vrhá stín na stránku. Stačí ji posunout o pár centimetrů do strany a čtení je najednou pohodlné.
U světla myslete na teplotu a směr. Studené bílé světlo v malé předsíni zvýrazní každou nerovnost a působí chladně; teplé bílé je příjemnější, ale při slabém výkonu dělá místnost ještě menší. Vhodné je kombinovat celkové světlo ze stropu s doplňkovým světlem u zrcadla. Svítidlo umístěte před zrcadlo nebo nad něj, nikdy ne za hlavu — jinak si při pohledu do zrcadla budete stínit obličej.
Vařte osvětlení v obýváku širokém hrnci, aby se voda odpařovala co nejrychleji. Směs broskví, jablek a cukru přiveďte k varu a poté stáhněte na střední plamen. Cukr přidávejte v poměru zhruba 400–500 g na kilogram ovoce, méně jen tehdy, pokud džem spotřebujete do několika týdnů. Míchejte často, zejména u dna, kde se cukr rád přichytí. Doba varu se pohybuje mezi 20 a 40 minutami podle šťavnatosti ovoce.
Základní neutrály — černá, bílá, šedá, tmavě modrá, béžová — drží šatník pohromadě, ale samy o sobě nestačí. Vyberte jednu výraznou barvu jako akcent a jednu tlumenou jako spojovací tón. Akcent se objevuje na doplňcích, tričku nebo svetru, tlumený tón na kalhotách, sukni nebo lehké vrstvě. Důležité je, aby se tyto dvě barvy daly kombinovat navzájem i s neutrály. Typická chyba je nakoupit tři různé výrazné barvy, které spolu neladí, a pak zjistit, že se každá dá nosit jen s černou. Tím kapsle ztrácí variabilitu a barvy se navzájem vytlačují.
Začněte návrhem zdrojů, ne kódu. Zdroj je podstatné jméno v množném čísle: /uzivatele, /objednavky. Vyhněte se slovesům v cestě (/getUzivatel) i hlubokému vnořování. Vztah mezi zdroji řešte cestou, ne parametry: /uzivatele/42/objednavky. Filtr, řazení a stránkování patří do query parametrů. Tento krok zabere hodinu a ušetří týdny přepisování, až se API rozroste.
Využijte výšku, ne podla
Na závěr dokumentujte kontrakt, ne implementaci. Popište vstup, výstup, kódy a limity. Když se kontrakt nezmění, klient může nasadit novou verzi serveru bez zásahu. To je celý smysl REST API: oddělit požadavek od odpovědi tak, aby mezi nimi nebylo nic skrytého.
Stavové kódy a chybové odpovědi Stavový kód není formalita. 200 znamená úspěch, 201 vytvoření, 204 smazání bez těla. 400 je chyba na straně klienta, 401 chybějící autentizace, 403 nedostatečné oprávnění, 404 neexistující zdroj, 409 konflikt, 422 neplatná data. 500 je chyba serveru a nemá unikat do odpovědi s detailem. Do těla chyby dejte strojově čitelný kód a krátkou zprávu. Nikdy nevracejte 200 s polem error — klient to přehlédne a vy budete ladit hodiny.
Testujte požadavek ještě před psaním klientského kódu. Nástroj příkazové řádky vám ukáže přesné hlavičky i tělo. Ověřte, co se stane při chybějícím tokenu, při neplatném JSON a při neexistujícím ID. Právě tyto tři případy tvoří většinu produkčních incidentů. Výsledek si uložte jako sadu příkladů, které poběží při každé změně.
První REST API vzniká nejčastěji tak, že někdo pošle požadavek a čeká odpověď. Mezi tím jsou ale rozhodnutí, která určí, jestli to bude fungovat i za měsíc. Požadavek má vždy metodu (GET, POST, PUT, DELETE), adresu zdroje a hlavičky. Tělo požadavku nese data jen u metod, které mění stav. Server odpovídá stavovým kódem, hlavičkami a tělem. Pokud tyto tři vrstvy pomícháte, vznikne chaos, který se těžko opravuje.
Typické chyby: posílání citlivých dat v query parametrech, protože se ukládají do logů. Chybějící verze v cestě (/v1/) u veřejného API. Ignorování hlavičky Content-Type, kvůli čemuž server nerozpozná JSON. A návrat celé databázové entity včetně interních ID a hesel. Odpověď má obsahovat jen to, co klient potřebuje. Pokud potřebujete víc, vytvořte samostatný endpoint, ne přidávejte pole do stávajícího.
U světla myslete na teplotu a směr. Studené bílé světlo v malé předsíni zvýrazní každou nerovnost a působí chladně; teplé bílé je příjemnější, ale při slabém výkonu dělá místnost ještě menší. Vhodné je kombinovat celkové světlo ze stropu s doplňkovým světlem u zrcadla. Svítidlo umístěte před zrcadlo nebo nad něj, nikdy ne za hlavu — jinak si při pohledu do zrcadla budete stínit obličej.
Vařte osvětlení v obýváku širokém hrnci, aby se voda odpařovala co nejrychleji. Směs broskví, jablek a cukru přiveďte k varu a poté stáhněte na střední plamen. Cukr přidávejte v poměru zhruba 400–500 g na kilogram ovoce, méně jen tehdy, pokud džem spotřebujete do několika týdnů. Míchejte často, zejména u dna, kde se cukr rád přichytí. Doba varu se pohybuje mezi 20 a 40 minutami podle šťavnatosti ovoce.
Základní neutrály — černá, bílá, šedá, tmavě modrá, béžová — drží šatník pohromadě, ale samy o sobě nestačí. Vyberte jednu výraznou barvu jako akcent a jednu tlumenou jako spojovací tón. Akcent se objevuje na doplňcích, tričku nebo svetru, tlumený tón na kalhotách, sukni nebo lehké vrstvě. Důležité je, aby se tyto dvě barvy daly kombinovat navzájem i s neutrály. Typická chyba je nakoupit tři různé výrazné barvy, které spolu neladí, a pak zjistit, že se každá dá nosit jen s černou. Tím kapsle ztrácí variabilitu a barvy se navzájem vytlačují.
Začněte návrhem zdrojů, ne kódu. Zdroj je podstatné jméno v množném čísle: /uzivatele, /objednavky. Vyhněte se slovesům v cestě (/getUzivatel) i hlubokému vnořování. Vztah mezi zdroji řešte cestou, ne parametry: /uzivatele/42/objednavky. Filtr, řazení a stránkování patří do query parametrů. Tento krok zabere hodinu a ušetří týdny přepisování, až se API rozroste.
Využijte výšku, ne podla
Na závěr dokumentujte kontrakt, ne implementaci. Popište vstup, výstup, kódy a limity. Když se kontrakt nezmění, klient může nasadit novou verzi serveru bez zásahu. To je celý smysl REST API: oddělit požadavek od odpovědi tak, aby mezi nimi nebylo nic skrytého.
Stavové kódy a chybové odpovědi Stavový kód není formalita. 200 znamená úspěch, 201 vytvoření, 204 smazání bez těla. 400 je chyba na straně klienta, 401 chybějící autentizace, 403 nedostatečné oprávnění, 404 neexistující zdroj, 409 konflikt, 422 neplatná data. 500 je chyba serveru a nemá unikat do odpovědi s detailem. Do těla chyby dejte strojově čitelný kód a krátkou zprávu. Nikdy nevracejte 200 s polem error — klient to přehlédne a vy budete ladit hodiny.
Testujte požadavek ještě před psaním klientského kódu. Nástroj příkazové řádky vám ukáže přesné hlavičky i tělo. Ověřte, co se stane při chybějícím tokenu, při neplatném JSON a při neexistujícím ID. Právě tyto tři případy tvoří většinu produkčních incidentů. Výsledek si uložte jako sadu příkladů, které poběží při každé změně.
První REST API vzniká nejčastěji tak, že někdo pošle požadavek a čeká odpověď. Mezi tím jsou ale rozhodnutí, která určí, jestli to bude fungovat i za měsíc. Požadavek má vždy metodu (GET, POST, PUT, DELETE), adresu zdroje a hlavičky. Tělo požadavku nese data jen u metod, které mění stav. Server odpovídá stavovým kódem, hlavičkami a tělem. Pokud tyto tři vrstvy pomícháte, vznikne chaos, který se těžko opravuje.
Typické chyby: posílání citlivých dat v query parametrech, protože se ukládají do logů. Chybějící verze v cestě (/v1/) u veřejného API. Ignorování hlavičky Content-Type, kvůli čemuž server nerozpozná JSON. A návrat celé databázové entity včetně interních ID a hesel. Odpověď má obsahovat jen to, co klient potřebuje. Pokud potřebujete víc, vytvořte samostatný endpoint, ne přidávejte pole do stávajícího.- 이전글Gdy kupujesz limitowaną kolekcję, tak sprawdzisz jej autentyczność 26.09.15
- 다음글Mikronährstoffe oder Makronährstoffe: Was wirklich zählt 26.09.15
댓글목록
등록된 댓글이 없습니다.