Když API přestane odpovídat, aneb jak se ptát Postmana správně > 자유게시판

• 목록
• 답변
• 글쓰기
• 게시판 리스트 옵션
  • 수정
  • 삭제

Pište v přítomném čase a v rozkazovacím způsobu, jako byste dávali příkaz k aplikaci změny: „Přidej validaci e-mailu", „Oprav přetečení bufferu". Vyhnete se tak podivným tvarům jako „přidána validace" nebo „přidání validace". Také se vyhněte minulému času, který je běžný v některých nástrojích, ale v češtině působí nepřirozeně a ztěžuje čtení logu. Před odesláním commitu si zkontrolujte, jestli je popis pravdivý a jestli nezmiňujete interní čísla úkolů bez kontextu. Pokud odkazujete na ticket, uveďte i krátký popis, protože číslo samo o sobě nic neřekne.

Nakonec si nastavte automatizaci. Postman umí spouštět kolekce z příkazové řádky, což se hodí pro pravidelné testy v rámci CI/CD. Pro začátek si ale vystačíte s tím, že si v Collection Runneru nastavíte iterace a data z CSV souboru. Pamatujte na to, že testy mají být deterministické – neměly by záviset na aktuálním čase nebo náhodných hodnotách, pokud to není účelem. Jinak budete opravovat testy, které selhávají jen kvůli špatně napsanému ověření.

Když stojíte před návrhem API, první otázka obvykle zní: REST, nebo GraphQL? Většina týmů sáhne po RESTu, protože ho zná, nebo po GraphQL, protože je moderní. Obě cesty ale vedou k problémům, pokud nerozumíte tomu, co přesně vaše aplikace potřebuje. Rozdíl není v tom, co je „lepší", ale v tom, co vám ušetří práci a co vám ji naopak přidá.

GraphQL řeší problém s nadbytečnými daty tím, že klient si řekne přesně o to, co potřebuje. To je velká výhoda pro mobilní aplikace nebo dashboardy, kde každý bajt dat navíc znamená pomalejší odezvu a byt v panelákuětší spotřebu dat. Na druhou stranu, GraphQL přináší nároky na server: musíte řešit N+1 dotazy, správné načítání dat a caching. Bez zkušeností skončíte s resolvery, které dělají desítky dotazů do databáze a výsledek je pomalejší než u RESTu. Další past je, že klient s GraphQL může poslat hluboce vnořený dotaz, který server zahltí – pokud nemáte omezení hloubky, snadno se stanete obětí DoS útoku.

Základním pravidlem je oddělit shrnutí od podrobností. První řádek by měl být krátký, do padesáti znaků, a měl by odpovídat na otázku, co commit dělá. Třeba „Oprava výpočtu DPH u faktur s měnou EUR". Tento řádek se zobrazuje v přehledech, logu i v e-mailech. Zbývající řádky oddělte prázdným řádkem a tam vysvětlete, proč jste změnu provedli, jaké měla důsledky a jaké alternativy jste zvažovali. Neopisujte, co je vidět v diffu — to už tam je. Pište to, co z kódu nevyčtete.

Nakonec si uvědomte, že commit message je komunikace s budoucími čtenáři — včetně vašeho budoucího já. Než commit odešlete, přečtěte si ho nahlas. Když zní jako věta, kterou byste sami pochopili bez znalosti kódu, je pravděpodobně dobrá. Když je vágní, doplňte podrobnosti. Tato minuta navíc se vám mnohonásobně vrátí, Feywild.Thirdrealm.Org až budete příště hledat, kde se stala chyba, nebo proč byla daná funkce napsaná zrovna takhle.

Nakonec si položte otázku, kdo se o databázi skutečně stará. Pokud je to jen vedlejší úkol někoho z týmu, dříve nebo později narazíte. Podpora databáze vyžaduje pravidelnou pozornost – sledování logů, čtvrtletní revize indexů a měsíční kontrola velikosti databáze. Když tyto činnosti nemají jasného vlastníka, vše se odkládá, až je problém akutní. Řešení je jednoduché: určete odpovědnost, nastavte pravidelné kontroly a nahlížejte na databázi jako na aktivum, které potřebuje údržbu, ne jako na černou skříňku, která funguje sama.

Než začnete psát první test, ověřte si, jakou verzi protokolu API používáte. Nejčastější chybou je předpoklad, že vše běží přes JSON s hlavičkou application/json. Starší služby ale mohou vyžadovat XML, formát formulářových dat nebo specifický API klíč v hlavičce. Otevřete si dokumentaci, najděte sekci s příklady požadavků, a teprve poté přejděte do Postmana. Klíčové je také správně nastavit prostředí – nepište adresy přímo do kolekce, ale použijte proměnné. Ušetříte si hodiny práce při přepínání mezi testovacím a produkčním prostředím.

Důležité je také myslet na caching. U RESTu máte HTTP cache, kterou můžete nastavit na úrovni endpointů – to je rychlé a jednoduché. U GraphQL je caching složitější, protože každý dotaz je unikátní a máte jediný endpoint. Pokud si nechcete komplikovat život, využijte knihovny jako Apollo Client nebo Relay, ale i tak musíte pochopit, jak fungují normalizace a invalidace cache. Bez toho skončíte s tím, že každý dotaz jde na server naplno, a to vás připraví o výkon.

Nejdůležitější je sledovat, jak se mění nároky na data v čase. To, co fungovalo při stovkách záznamů, selhává u milionů. Typická chyba je spoléhat na to, že databáze si poradí sama. Neřekne vám, že chybí vhodný index, dokud není pozdě. Pravidelně proto kontrolujte plán provádění dotazů a hledejte operace typu sekvenční skenování velkých tabulek. Pokud je najdete, zvažte přidání indexu nebo přepsání dotazu – často pomůže i pouhé rozdělení složitého dotazu na menší části.

In case you loved this informative article and you wish to receive details relating to osvětlení v Obýváku generously visit our web site.