Jak postavit REST API s Node.js a Express: praktický průvodce

Nejdůležitější částí testu není samotný kód, ale to, co testujete. Zaměřte se na hraniční případy: co se stane, když funkce dostane nulu, záporné číslo, prázdný řetězec nebo null? Právě tam se nejčastěji skrývají chyby. Napište tři testy pro jednu funkci: jeden pro běžný vstup, jeden pro hraniční hodnotu a jeden pro neočekávaný vstup. Tím zajistíte, že váš kód nefunguje jen pro příklad z tutoriálu, ale i v reálném nasazení.

Nejdříve si vyberte nástroj, kterým budete API testovat. Můžete použít přímo příkazovou řádku a nástroj pro odesílání HTTP požadavků, ale pro začátek je pohodlnější grafický program, který vám ukáže odpověď v přehledné podobě. Stačí zadat adresu (endpoint) a zvolit metodu, obvykle GET pro čtení dat. Zkuste najít veřejné API, které vrací aktuální čas, počasí nebo seznam zemí. Cílem je vidět první odpověď ve formátu JSON – to je textová struktura, kterou snadno přečte nejen člověk, ale i program.

Praktický tip: začněte s malým projektem, který má jasný cíl. Například aplikace, která načte seznam uživatelů a zobrazí jejich jména. Postupně přidávejte funkce – filtrování, řazení, zápis do souboru. Tím si osvojíte nejen volání API, ale i zpracování dat a práci s chybami. Vyhnete se tak frustraci z příliš složitého zadání na začátku.

Jakmile máte první odpověď, zkuste si ji rozebrat. JSON vypadá jako vnořené objekty a pole, kde ke každé hodnotě vede klíč. Například u počasí to může být klíč pro teplotu, vlhkost nebo popis. Abyste s daty mohli pracovat, je vhodné je uložit do proměnné a postupně z ní vytahovat jednotlivé hodnoty. Většina moderních jazyků má pro JSON zabudovanou podporu, takže nemusíte psát žádný složitý parser. Důležité je naučit se číst dokumentaci API – tam najdete seznam dostupných endpointů, povinné parametry a strukturu odpovědí.

Nejčastější chyby a jak se jim vyhnout Jednou z nejčastějších chyb je používání nepřipnutých verzí akcí. Místo @v3 nebo @v4 použijte přesný SHA commit, aby se vaše pipeline nerozbila při další aktualizaci akce. Stejně tak si dejte pozor na bezpečnostní tajemství – nikdy je nevkládejte přímo do YAML souboru. Používejte secrets, které máte uložené v nastavení repozitáře, a odkazujte se na ně přes proměnné prostředí. Pokud posíláte citlivé údaje do logů, můžete je maskovat, ale nejlepší je se jim úplně vyhnout.

Klíčové kroky pro čistou strukturu kódu Pro větší projekty se vyplatí rozdělit kód do modulů – routery pro jednotlivé zdroje, kontrolery pro logiku a služby pro práci s daty. Místo psaní všech endpointů do jednoho souboru použijte express.Router(). Například pro správu uživatelů: ve složce routes vytvořte userRoutes.js a v něm definujte GET, POST, PUT a DELETE. Poté router připojte v hlavním souboru pomocí app.use('/api/users', userRouter). Tím udržíte kód přehledný a snadno testovatelný.

Jak se vyhnout nejčastějším chybám při psaní testů Nejčastější chyba začátečníků je testování příliš mnoha věcí najednou. Jeden test by měl ověřovat jen jednu věc. Pokud máte v jednom testu pět asercí, a první selže, nezjistíte, jestli fungují ostatní. Rozdělte testy na menší celky. Druhou chybou je testování implementace místo chování. Nezáleží na tom, jestli funkce používá cyklus nebo rekurzi. Důležité je, co vrací. Test by neměl kontrolovat, jak je funkce napsaná, ale že dělá to, co má.

Při návrhu endpointů dbejte na správné použití HTTP metod. GET pro čtení, POST pro vytvoření, PUT nebo PATCH pro úpravu a DELETE pro mazání. Nezapomeňte na validaci vstupních dat – bez ní se brzy dočkáte neočekávaných chyb. Pro validaci použijte knihovnu (například Joi nebo express-validator), která vám umožní definovat pravidla pro jednotlivá pole. Typickou chybou začátečníků je spoléhat se na to, že data z klienta jsou vždy správná – to je cesta k děravému rozhraní.

Na závěr: TypeScript se nejlépe učí při práci na reálném projektu. Začněte tím, že si do existujícího JavaScriptového projektu přidáte konfigurační soubor a postupně přepnete soubory na .ts. Sledujte chyby, které editor hlásí, a opravujte je. Po pár týdnech zjistíte, že píšete kód rychleji, protože se nemusíte spoléhat na paměť a dokumentaci. Chyby odhalíte dřív, než se dostanou k uživatelům, a to je největší přínos, který TypeScript nabízí.

Základní pipeline začíná souborem, který definuje událost spouštějící workflow. Nejčastěji používáte push do větve main nebo pull request. Důležité je omezit spouštění na relevantní větve, jinak se pipeline spustí při každém pushi do libovolné větve, což zbytečně zatěžuje běhy. Dobrým zvykem je přidat filtr na cesty – pokud změníte pouze dokumentaci, nemá smysl spouštět celý build. Využijte klíčové slovo paths a paths-ignore pro efektivní řízení spouštění.