6 zásad, jak dokumentovat API, aby frontend nečekal

Co dělat, když API vrací chybu? Než začnete volat API, naučte se číst odpovědi. Každá odpověď má stavový kód. Kód 200 znamená úspěch, 404 znamená, že zdroj neexistuje, 401 znamená neplatné ověření, 429 znamená, že jste překročili limit požadavků. Většina začátečníků ignoruje tyto kódy a jen předpokládá, že data přijdou. To je špatně. Vždy zkontrolujte, jestli je odpověď úspěšná, a podle toho se zachovejte. Pokud dostanete 429, počkejte, než pošlete další požadavek, nebo zpomalte volání. Jinak vás API může dočasně zablokovat.

Praktická rada: do dokumentace uveďte i informaci o autentizaci a oprávněních. Frontend potřebuje vědět, které endpointy vyžadují token, jak ho předat a co se stane, když chybí. Uveďte také limity na počet požadavků, pokud existují, a jak je poznáte. To jsou detaily, které se na první pohled nezdají důležité, ale bez nich se frontend zasekne. Až budete psát dokumentaci, zkuste si představit, že ji čte člověk, který nezná vnitřní strukturu backendu. Ptá se: „Co přesně pošlu a co dostanu?" – a vy mu na to musíte odpovědět bez nutnosti ptát se vás.

Když už máte podezření na konkrétní místo, nespěchejte s úpravami. Nejprve si v konzoli vyzkoušejte, jak se daný výraz chová. Napište název proměnné a stiskněte Enter – prohlížeč vám zobrazí její aktuální hodnotu. Stejně tak můžete volat funkce přímo z konzole, abyste otestovali různé vstupy. Tento interaktivní přístup ušetří spoustu času, protože nemusíte pokaždé znovu načítat stránku. Pokud ale narazíte na chybu, která se objevuje jen u některých uživatelů, zkuste v panelu Network zakliknout možnost „Offline" a simulovat tak výpadek sítě. Podobně si můžete v prohlížeči otevřít anonymní okno a vyloučit tak vliv rozšíření a starých cache souborů.

Typické chyby, na které breakpointy nestačí Někdy se problém neprojeví jako výjimka, ale jako nesprávné chování stránky – tlačítko nefunguje, nebo se obsah neaktualizuje. V takovém případě se vyplatí sledovat síťovou komunikaci. Otevřete panel Network a podívejte se na požadavky, které se odesílají. Často zjistíte, že se data odesílají na špatnou adresu, nebo že odpověď přichází ve formátu, se kterým kód neumí pracovat. Pokud pracujete s REST API, klikejte na jednotlivé požadavky a prohlédněte si jejich hlavičky a tělo odpovědi. Další častou pastí je asynchronní kód – funkce s klíčovým slovem async, úPrava InteriéRu nebo použití setTimeout. Zde pomáhá dočasně přidat do kódu příkaz console.log na rekonstrukce koupelny krok za krokemčátek a konec dané funkce. Zjistíte tak, zda se kód vůbec spustí, a v jakém pořadí se jednotlivé části vykonávají.

Základem je obraz a kontejner. Obraz je neměnný šablona, kontejner je běžící instance. Když vytvoříte obraz, měli byste myslet na to, že každá vrstva, kterou přidáte, je trvalá. Nejčastější chyba začátečníků: instalují balíčky nebo kopírují soubory, které v další vrstvě smažou, ale výsledný obraz je stále velký a pomalý. Řešení je jednoduché — kombinovat příkazy barvy stěn do obýváku jedné vrstvy a mazat dočasné soubory ve stejném kroku.

Kdyz uz se rozhodnete, ze zacnete implementovat, stanovi si jasne kriteria pro to, kdy analyzu ukoncite. Napriklad: „analyza konci, kdyz mame odsouhlaseny akceptacni testy pro danou funkci". Tento pristup vytvori hranici, ktera zabrani tomu, aby se analyticka faze neustale protahovala. Na druhou stranu, pokud behem implementace narazite na zásadni nejasnost, nevracejte se k velke analyze — vyresite ji kratkym sjednocenim v ramci tymu a zapracujte zmenu do odhadu. Dulezite je, aby odhady nebyly jednorazova aktivita, ale ziva soucast agilniho planovani, kterou pravidelne vyhodnocujete a upravujete na zaklade realnych dat.

Třetí pastí je síťová konfigurace. Docker automaticky vytváří izolované sítě, ale ne všechny porty jsou hned dostupné. Pokud chcete, aby kontejner komunikoval s okolím, musíte explicitně publikovat porty. Bez toho se k aplikaci nedostanete ani z vlastního počítače. Častý nešvar je také spoléhání na IP adresu kontejneru. Ta se může měnit při každém restartu. Místo toho používejte názvy služeb, které Docker rozlišuje v rámci jedné sítě.

Každý JavaScriptový kód čas od času selže. Nejčastější chybou bývá špatně zapsaná proměnná, nesprávný datový typ nebo zapomenutá čárka. Než začnete cokoli opravovat, otevřete si vývojářské nástroje. V prohlížeči Chrome i Firefoxu je otevřete klávesou F12, případně pravým tlačítkem myši na stránce a volbou „Prozkoumat". Na panelu Console se vám zobrazí nejen chybová hlášení, ale i varování a logy, které jste si sami přidali. Všímejte si čísla řádku a názvu souboru, které jsou součástí hlášení – to je první vodítko, kde hledat problém.

Here is more information regarding více informací najdete zde look at the webpage.