Nakonec se vyplatí do dokumentace přidat i praktické interaktivní prostředí, kde si frontend může zavolat API přímo z prohlížeče. Nemusí to být nic složitého – stačí možnost zadat parametry a zobrazit odpověď. Až frontend narazí na nejasnost, místo psaní e-mailu si všechno vyzkouší sám. Taková dokumentace se stává nástrojem, ne přítěží. Pokud se navíc pravidelně kontroluje a aktualizuje při každé změně kódu, spolupráce se výrazně zrychlí a počet chyb klesne na minimum. Důležité je, aby dokumentaci vnímal jako svůj úkol celý tým, nejen backend.
Postman je jedním z nejrozšířenějších nástrojů pro testování API, ale jeho skutečná síla se projeví až ve chvíli, kdy pochopíte jeho základní koncepty. Než začnete psát první testy, osvojte si práci s prostředím (environment) a kolekcemi (collections). Kolekce slouží jako organizovaný seznam požadavků, které můžete sdílet s týmem, zatímco prostředí umožňuje definovat proměnné – typicky adresu serveru, přihlašovací tokeny nebo identifikátory. Pokud tyto dvě funkce ignorujete, budete neustále ručně přepisovat URL adresy a klíče, což vede k chybám a ztrátě času.
Nakonec si osvojte práci s ověřením schématu odpovědi – místo kontroly každé položky zvlášť použijte knihovnu ajv nebo pm.expect s předem definovaným JSON schématem. Tím pokryjete celou strukturu odpovědi a vyhnete se situaci, kdy test projde, ale API vrátilo jiný typ dat, než se čekalo. Testování API není jen o odeslání požadavku a sledování status kódu; je to systematická práce s daty, která vyžaduje pečlivost a pochopení nástroje. S těmito postupy přestanete bojovat s nástrojem a začnete efektivně odhalovat chyby dřív, než se dostanou do produkce.
Než začnete psát první řádky kódu, ujasněte si, co má stránka dělat. HTML je kostra, CSS je vzhled. Bez kostry se CSS nemá čeho chytit, bez CSS vypadá kostra jako dokument z devadesátých let. Základní struktura HTML dokumentu je jednoduchá: doctype, html, head a body. Do head patří meta informace a odkaz na CSS soubor, do body veškerý viditelný obsah. Pokud vynecháte doctype, prohlížeč se přepne do takzvaného quirks módu a vaše CSS bude fungovat jinak, než čekáte. Tohle je nejčastější začátečnická chyba, která se projeví až při stylování.
Typickou chybou je také nesprávné používání HTTP metod. Často vidím, že se pro mazání zdroje používá POST nebo že se stav mění přes GET. Držte se konvencí: GET na čtení, POST na vytváření, PUT nebo PATCH na úpravu a DELETE na smazání. To není jen formalita – správné metody usnadňují práci klientům i nástrojům pro testování. Navíc si usnadníte implementaci cache a automatické dokumentace.
Při návrhu API se vyplatí myslet na verzování. I když to na začátku vypadá jako zbytečná práce, později vám to ušetří spoustu bolesti. Nastavte verzi v URL, například /api/v1/uzivatele, nebo použijte hlavičky. Změny v API pak můžete zavádět postupně, aniž byste rozbili aplikace, které na vašem API běží. Starší verze můžete po čase odstranit, ale mějte vždy dostatečně dlouhou dobu na migraci.
Pro práci s CSS používejte externí soubor, ne style přímo v HTML. Oddělení obsahu od vzhledu vám umožní měnit design bez zásahu do struktury. Stačí v head připojit odkaz na CSS soubor a v něm definovat pravidla. Selektory píšete podle tříd, id a elementů. Třídy jsou univerzální, id používejte jen pro jedinečné prvky. Pokud chcete nadpis označit modře, napište .nadpis a v HTML
. Vyhněte se stylování podle id, protože to snižuje přehlednost a ztěžuje pozdější úpravy.
Nezapomínejte ani na verze API a na to, jakým způsobem se řeší zpětná kompatibilita. Frontend často běží v produkci a nemůže si dovolit, aby backend přestal podporovat staré parametry přes noc. Dokumentace by měla jasně označovat, která verze je aktuální a kdy bude starší verze ukončena. Dobrým zvykem je také popsat, jak vypadá autentizace a oprávnění – které endpointy vyžadují token, jak ho frontend získá a co se stane, když vyprší. Tyto informace bývají často roztroušené v kódu, ale pro frontend jsou zásadní.
První praktický krok: vytvořte si kolekci a do ní přidejte požadavek GET na váš testovací endpoint. V záložce Tests napište jednoduchý skript v JavaScriptu, který ověří, že odpověď má status 200 a obsahuje očekávané JSON pole. Například pomocí pm.response.to.have.status(200) a pm.expect(pm.response.json()).to.have.property(‘id’). Tento skript se spustí po každém odeslání požadavku, takže okamžitě uvidíte, zda API funguje podle očekávání. Vždy začínejte s malými testy – jeden požadavek, jedna kontrola – a teprve poté přidávejte složitější scénáře.
