Postman

1. Co je Postman?

Postman je nástroj pro testování API, který umožňuje vývojářům, testerům a QA specialistům snadno posílat HTTP požadavky a analyzovat odpovědi. Postman nabízí bohaté možnosti pro testování, automatizaci, dokumentaci a správu API. Je to jeden z nejběžněji používaných nástrojů pro testování API.

Klíčové vlastnosti Postman:

• Posílání požadavků: Postman umožňuje posílat HTTP požadavky (GET, POST, PUT, DELETE, PATCH) na různé URL a API endpointy.
• Testování API: Umožňuje vytváření testů pro ověřování odpovědí API, včetně status kódů, obsahu odpovědi a dalších metrik.
• Podpora pro environmenty: Postman umožňuje pracovat s různými prostředími (např. vývojové, testovací, produkční) a nastavovat proměnné specifické pro každé prostředí.
• Automatizace testů: Postman umožňuje automatizovat testování API pomocí Collection Runner a dalších nástrojů.
• Generování dokumentace: Automaticky generuje dokumentaci pro vaše API na základě testů a požadavků.

2. Instalace Postmanu

Postman lze stáhnout a nainstalovat na Windows, macOS a Linux. Pro stažení a instalaci navštivte oficiální stránku Postman Downloads.

3. Posílání HTTP požadavků v Postman

V Postman můžete posílat různé typy HTTP požadavků, například GET, POST, PUT a DELETE. Před odesláním požadavku je třeba vybrat správný HTTP metodu a zadat URL.

Ukázka odeslání GET požadavku:

• Vyberte metodu GET z rozbalovacího seznamu v levém horním rohu.
• Zadejte URL (např. https://api.example.com/data) do textového pole pro URL.
• Klikněte na tlačítko Send.

Po odeslání požadavku Postman zobrazí odpověď v panelu na pravé straně, kde můžete zkontrolovat status kód, hlavičky odpovědi a tělo odpovědi.

4. Tvorba testů v Postman

Postman umožňuje psát testy v JavaScriptu, které se vykonají po odeslání požadavku. Testy mohou kontrolovat, zda odpověď obsahuje správný status kód, tělo odpovědi nebo další metriky.

Ukázkový test pro kontrolu status kódu:

pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});
    

Tento test ověřuje, zda odpověď obsahuje status kód 200.

Testování odpovědi:

pm.test("Body matches string", function () {
    pm.response.to.have.body("Hello, world!");
});
    

Tento test ověřuje, zda tělo odpovědi obsahuje text "Hello, world!".

5. Práce s environmenty a proměnnými

Postman podporuje práci s environmenty a proměnnými, které vám umožňují testovat API v různých prostředích (např. vývojové, testovací, produkční).

Vytvoření nového prostředí:

• Klikněte na ikonu ozubeného kolečka v pravém horním rohu.
• Vyberte Manage Environments.
• Klikněte na Add pro vytvoření nového prostředí a nastavte proměnné, například base_url.

Poté můžete použít proměnné v požadavcích:

https://{{base_url}}/api/v1/data
    

Postman automaticky nahradí {{base_url}} hodnotou, která je definována v environmentu.

6. Collection Runner a automatizace testů

Collection Runner je nástroj v Postmanu, který vám umožňuje spustit více požadavků (v rámci jedné kolekce) a spustit automatizované testy na základě těchto požadavků.

Spuštění kolekce:

• V Postmanu otevřete kolekci, kterou chcete spustit.
• Klikněte na tlačítko Run.
• V kolekci můžete přidat různá prostředí, testy a proměnné pro spouštění opakovaných testů.

Po spuštění kolekce Postman vykoná každý požadavek a zaznamená výstupy, včetně testů a odpovědí.

7. Generování dokumentace

Postman umožňuje automaticky generovat dokumentaci pro API. Tato dokumentace může být sdílena s týmem nebo zveřejněna na webu.

Vytvoření dokumentace pro kolekci:

• Otevřete kolekci, kterou chcete dokumentovat.
• Klikněte na tlačítko ... (tři tečky) a vyberte Generate Documentation.
• Postman vygeneruje dokumentaci ve formátu HTML, kterou můžete sdílet.

8. Integrace Postman do CI/CD

Postman lze integrovat do CI/CD pipeline pomocí Postman Collection Runner nebo Newman (postman CLI nástroj). To umožňuje automatické spouštění testů API během vývoje nebo při nasazení.

Ukázka spouštění testů pomocí Newman:

newman run mycollection.json -e myenvironment.json
    

Tento příkaz spustí kolekci mycollection.json v prostředí myenvironment.json.

9. Závěr

Postman je silný nástroj pro testování API, který vám umožňuje snadno posílat požadavky, ověřovat odpovědi a automatizovat testy. S jeho pomocí můžete rychle identifikovat problémy v API, monitorovat jejich výkon a zajišťovat správné fungování aplikací. Postman také umožňuje integraci s CI/CD procesy pro pravidelné testování API během vývoje.