Postman Návod – Jak používat pro testování API?
Co je to Postman?
Postman je škálovatelný testovací nástroj API, který se rychle integruje do potrubí CI/CD. Začalo to v roce 2012 jako vedlejší projekt Abhinav Asthana pro zjednodušení pracovního postupu API při testování a vývoji. API je zkratka pro Application Programming Interface, která umožňuje softwarovým aplikacím komunikovat mezi sebou prostřednictvím volání API.
Proč používat Postman?
S více než 4 miliony uživatelů v současnosti Postman Software se stal nástrojem volby z následujících důvodů:
- Přístupnost – k použití Postman stačí se přihlásit ke svým vlastním účtům, což usnadňuje přístup k souborům kdykoli a kdekoli, pokud Postman aplikace je nainstalována v počítači.
- Použití sbírek – Postman umožňuje uživatelům vytvářet kolekce pro jejich Postman volání API. Každá kolekce může vytvářet podsložky a více požadavků. To pomáhá při organizaci vašich testovacích sad.
- Spolupráce – Kolekce a prostředí lze importovat nebo exportovat, což usnadňuje sdílení souborů. Ke sdílení sbírek lze také použít přímý odkaz.
- Vytváření prostředí – Mít více prostředí pomáhá méně opakovat testy, protože lze použít stejnou kolekci, ale pro jiné prostředí. Zde bude probíhat parametrizace, kterou probereme v dalších lekcích.
- Vytváření testů – Ke každému lze přidat kontrolní body testu, jako je ověření úspěšného stavu odpovědi HTTP Postman Volání API, která pomáhají zajistit pokrytí testu.
- Automatizační testování – Díky použití Collection Runner nebo Newman lze testy spouštět ve více iteracích, což šetří čas pro opakované testy.
- Ladění – Postman konzole pomáhá kontrolovat, jaká data byla načtena, což usnadňuje ladění testů.
- Kontinuální integrace – Díky své schopnosti podporovat nepřetržitou integraci jsou zachovány rozvojové postupy.
Jak používat Postman pro spouštění API
Níže je Postman Pracovní prostor. Pojďme prozkoumat postup krok za krokem Jak používat Postman a různé vlastnosti Postman nářadí!
- New – Zde vytvoříte nový požadavek, kolekci nebo prostředí.
- Import – Používá se k importu kolekce nebo prostředí. K dispozici jsou možnosti jako import ze souboru, složky, odkazu nebo vložení surového textu.
- Runner – Automatizační testy lze provádět prostřednictvím sběrného běhu. To bude dále probráno v další lekci.
- Otevřít nový – otevřete novou kartu, Postman Okno nebo Runner Window kliknutím na toto tlačítko.
- Můj pracovní prostor – Nový pracovní prostor můžete vytvořit individuálně nebo jako tým.
- Pozvat – Spolupracujte na pracovním prostoru pozváním členů týmu.
- Historie – minulé požadavky, které jste odeslali, se zobrazí v historii. To usnadňuje sledování akcí, které jste provedli.
- Kolekce – Uspořádejte si testovací sadu vytvářením kolekcí. Každá kolekce může mít podsložky a více požadavků. Požadavek nebo složku lze také duplikovat.
- Záložka Požadavek – zobrazuje název požadavku, na kterém pracujete. Ve výchozím nastavení se u požadavků bez názvu zobrazí „Požadavek bez názvu“.
- Požadavek HTTP – Kliknutím na toto tlačítko zobrazíte rozevírací seznam různých požadavků, jako je GET, POST, COPY, DELETE atd. Postman API testování, nejčastěji používané požadavky jsou GET a POST.
- Požadavek URL – Také známý jako koncový bod, zde identifikujete odkaz, se kterým bude API komunikovat.
- Uložit – Pokud jsou v požadavku změny, je nutné kliknout na tlačítko Uložit, aby se nové změny neztratily nebo nepřepsaly.
- Parametry – Zde budete zapisovat parametry potřebné pro požadavek, jako jsou hodnoty klíčů.
- Autorizace – Pro přístup k API je nutná řádná autorizace. Může být ve formě uživatelského jména a hesla, tokenu nosiče atd.
- Záhlaví – můžete nastavit záhlaví, jako je typ obsahu JSON v závislosti na potřebách organizace.
- Body – Zde lze upravit podrobnosti v požadavku běžně používaném v požadavku POST.
- Pre-request Script – Jedná se o skripty, které budou provedeny před požadavkem. Obvykle se používají skripty předběžného požadavku pro prostředí nastavení, aby bylo zajištěno, že testy budou probíhat ve správném prostředí.
- Testy – Jedná se o skripty spouštěné během požadavku. Je důležité mít testy, protože nastavuje kontrolní body pro ověření, zda je stav odpovědi v pořádku, načtená data jsou podle očekávání a další testy.
Práce s požadavky GET
Požadavky Get se používají k načtení informací z dané adresy URL. V koncovém bodu nebudou provedeny žádné změny.
Pro všechny příklady v tomto budeme používat následující URL Postman konzultace https://jsonplaceholder.typicode.com/users
V pracovním prostoru
- Nastavte svůj požadavek HTTP na GET.
- Do pole URL požadavku zadejte odkaz
- Klikněte na Odeslat
- Zobrazí se zpráva 200 OK
- V těle by mělo být 10 uživatelských výsledků, což znamená, že váš test proběhl úspěšně.
* Poznámka: Mohou nastat případy, kdy Get Postman žádost může být neúspěšná. Může to být způsobeno neplatnou adresou URL požadavku nebo je potřeba ověření.
Práce s POST požadavky
Požadavky na odeslání se liší od požadavku na získání, protože dochází k manipulaci s daty, kdy uživatel přidává data do koncového bodu. Pomocí stejných dat z předchozího tutoriálu v Get requestu nyní přidáme našeho vlastního uživatele.
Krok 1) Kliknutím na novou kartu vytvoříte nový požadavek.
Krok 2) V nové záložce
- Nastavte svůj požadavek HTTP na POST.
- Zadejte stejný odkaz do adresy URL požadavku: https://jsonplaceholder.typicode.com/users
- přepněte na kartu Tělo
Krok 3) V těle,
- Klikněte na raw
- Vyberte JSON
Krok 4) Zkopírujte a vložte pouze jeden uživatelský výsledek z předchozí žádosti o získání, jak je uvedeno níže. Ujistěte se, že kód byl zkopírován správně se spárovanými složenými závorkami a hranatými závorkami. Změňte id na 11 a jméno na libovolné požadované jméno. Můžete také změnit další podrobnosti, jako je adresa.
[ { "id": 11, "name": "Krishna Rungta", "username": "Bret", "email": "Sincere@april.biz", "address": { "street": "Kulas Light", "suite": "Apt. 556", "city": "Gwenborough", "zipcode": "92998-3874", "geo": { "lat": "-37.3159", "lng": "81.1496" } }, "phone": "1-770-736-8031 x56442", "website": "hildegard.org", "company": { "name": "Romaguera-Crona", "catchPhrase": "Multi-layered client-server neural-net", "bs": "harness real-time e-markets" } } ]
* Poznámka: Požadavek online Post by měl mít správný formát, aby bylo zajištěno, že budou vytvořena požadovaná data. Je dobrým zvykem použít Get first ke kontrole formátu JSON požadavku. Můžete použít nástroje jako https://jsonformatter.curiousconcept.com/
Krok 5) Dále
- Klikněte na Odeslat.
- Stav: 201 Vytvořeno by se mělo zobrazit
- Odeslaná data se zobrazují v těle.
Jak parametrizovat požadavky
Parametrizace dat je jednou z nejužitečnějších funkcí Postman. Místo vytváření stejných požadavků s různými daty můžete použít proměnné s parametry. Tato data mohou pocházet z datového souboru nebo proměnné prostředí. Parametrizace pomáhá vyhnout se opakování stejných testů a lze použít iterace testování automatizace.
Parametry jsou vytvářeny pomocí dvojitých složených závorek: {{sample}}. Podívejme se na příklad použití parametrů v našem předchozím požadavku:
Nyní vytvoříme parametrizační požadavek get.
Krok 1)
- Nastavte svůj požadavek HTTP na GET
- Vložte tento odkaz: https://jsonplaceholder.typicode.com/users. Nahraďte první část odkazu parametrem, například {{url}}. Adresa URL požadavku by nyní měla být {{url}}/users.
- Klikněte na odeslat.
Neměla by být žádná odpověď, protože jsme nenastavili zdroj našeho parametru.
Krok 2) Chcete-li použít parametr, musíte nastavit prostředí
- Klikněte na ikonu oka
- Kliknutím na Upravit nastavíte proměnnou na globální prostředí, které lze použít ve všech kolekcích.
Krok 3) V proměnné,
- nastavte název na adresu URL, která je https://jsonplaceholder.typicode.com
- klikněte na Uložit.
Krok 4) Pokud uvidíte další obrazovku, klikněte na Zavřít
Krok 5) Vraťte se ke svému požadavku získat a klikněte na odeslat. Nyní by měly být výsledky vašeho požadavku.
* Poznámka: Vždy se ujistěte, že vaše parametry mají zdroj, jako je proměnná prostředí nebo datový soubor, abyste předešli chybám.
Jak vytvořit Postman Zkoušky
Postman Testy jsou JavaKódy skriptů přidané do požadavků, které vám pomohou ověřit výsledky, jako je úspěšný nebo neúspěšný stav, porovnání očekávaných výsledků atd. Obvykle to začíná pm.test. Lze jej přirovnat k příkazům aserts, ověřovat, které jsou k dispozici v jiných nástrojích.
Udělejme pár základních věcí API testování použitím Postman pro naše požadavky na parametrizaci z předchozí lekce.
Krok 1) Přejděte na svůj požadavek uživatele GET z předchozího kurzu.
- Přepněte na kartu testy. Na pravé straně jsou útržkové kódy.
- V části úryvky klikněte na „Stavový kód: Kód je 200“.
Panel se vyplní automaticky
Krok 2) Nyní klikněte na Odeslat. Nyní by se měl zobrazit výsledek testu.
Krok 3) Vraťte se na kartu test a přidejte další test. Tentokrát porovnáme očekávaný výsledek se skutečným výsledkem.
V části úryvky klikněte na „Tělo odpovědi: Kontrola hodnoty JSON“. Budeme kontrolovat, zda má Leanne Graham uživatelské jméno 1.
Krok 4)
- Nahraďte „Your Test Name“ z kódu „Zkontrolujte, zda uživatel s id1 je Leanne Graham“, aby název testu přesně specifikoval, co chceme testovat.
- Nahraďte jsonData.value jsonData[0].name. Chcete-li získat cestu, zaškrtněte tělo dříve v části Získat výsledek. Protože Leanne Graham má uživatelské ID 1, jsonData je v prvním výsledku, který by měl začínat 0. Pokud chcete získat druhý výsledek, použijte jsonData[1] a tak dále pro následné výsledky.
- Do eql zadejte „Leanne Graham“
pm.test("Check if user with id1 is Leanne Graham", function () { var jsonData = pm.response.json(); pm.expect(jsonData[0].name).to.eql("Leanne Graham"); });
Krok 5) Klikněte na odeslat. Nyní by pro vaši žádost měly existovat dva úspěšné výsledky testu.
* Poznámka: Existují různé druhy testů, které lze vytvořit Postman. Zkuste nástroj prozkoumat a uvidíte, jaké testy budou vyhovovat vašim potřebám.
Jak vytvářet sbírky
Kolekce hrají důležitou roli při organizování testovacích sad. Lze jej importovat a exportovat, což usnadňuje sdílení sbírek v týmu. V tomto tutoriálu se naučíme, jak vytvořit a spustit kolekci.
Začněme tvorbou kolekce:
Krok 1) Klikněte na tlačítko Nový v levém horním rohu stránky.
Krok 2) Vyberte Sbírka. Mělo by se objevit okno pro vytvoření sbírky.
Krok 3) Zadejte požadovaný název kolekce a popis a klikněte na vytvořit. Nyní by měla být vytvořena sbírka.
Krok 4) Vraťte se k předchozímu požadavku Get. Klikněte na Uložit
Krok 5)
- vybrat Postman Testovací kolekce.
- Klikněte na Uložit do Postman Testovací kolekce
Krok 6) Postman testovací kolekce by nyní měla obsahovat jeden požadavek.
Krok 7) Opakujte kroky 4-5 pro předchozí požadavek Post, takže kolekce bude mít nyní dva požadavky.
Jak spouštět sbírky pomocí nástroje Collection Runner
Existují dva způsoby, jak spustit kolekci, a to Collection Runner a Newman. Začněme spuštěním kolekce v aplikaci Collection Runner.
Krok 1) Klikněte na tlačítko Runner, které se nachází v horní části stránky vedle tlačítka Import.
Krok 2) Stránka Runner kolekce by měla vypadat jako níže. Následuje popis různých oborů
Krok 3) Spusť svůj Postman Otestujte kolekci nastavením následujícího:
- Vybrat Postman kolekce testů – nastavte iterace jako 3
- Nastavte zpoždění na 2500 ms
- Klikněte na možnost Spustit Postman Tlačítko Test…
Krok 4) Stránka Run Results by se měla zobrazit po kliknutí na tlačítko Run. V závislosti na zpoždění byste měli vidět testy při jejich provádění.
- Po dokončení testů můžete vidět stav testu, zda je úspěšný nebo neúspěšný, a výsledky za iteraci.
- U Get Requests vidíte stav Pass
- Protože jsme pro Post neměli žádné testy, měla by se zobrazit zpráva, že požadavek neměl žádné testy.
Můžete vidět, jak je důležité, aby vaše požadavky obsahovaly testy, abyste mohli ověřit stav požadavku HTTP, pokud je úspěšný a data jsou vytvořena nebo načtena.
Jak spouštět sbírky pomocí Newmana
Dalším způsobem, jak spustit kolekci, je přes Newman. Hlavní rozdíly mezi Newmanem a Collection Runnerem jsou následující:
- Newman je doplněk pro Postman. Budete ji muset nainstalovat samostatně z nativní aplikace.
- Newman používá příkazový řádek, zatímco Collection Runner má GUI.
- Newman lze použít pro kontinuální integraci.
Chcete-li nainstalovat Newman a spustit z něj naši kolekci, postupujte takto:
Krok 1) Nainstalujte nodejs pomocí tohoto odkazu: http://nodejs.org/download/
Krok 2) Otevřete příkazový řádek a zadejte
npm install -g newman
Newman by nyní měl být nainstalován na vašem počítači.
Krok 3) Jakmile je Newman nainstalován, vraťme se k našemu Postman V poli Kolekce klikněte na tři tečky. Nyní by se měly objevit možnosti. Vyberte Export.
Krok 4) Vyberte Exportovat kolekci jako kolekci v2.1 (doporučeno) a poté klikněte na Exportovat.
Krok 5) Vyberte požadované umístění a klikněte na Uložit. Je vhodné vytvořit pro vás konkrétní složku Postman testy. Sbírka by se nyní měla exportovat do vámi zvoleného místního adresáře.
Krok 6) Budeme také muset vyvážet naše životní prostředí. Klikněte na ikonu oka vedle rozevíracího seznamu prostředí v Global, vyberte Stáhnout jako JSON. Vyberte požadované umístění a klikněte na Uložit. Je vhodné, aby prostředí bylo ve stejné složce jako vaše sbírka.
Krok 7) Prostředí by nyní mělo být exportováno do stejného místního adresáře jako Collection.
Krok 8) Nyní se vraťte na příkazový řádek a změňte adresář, kam jste uložili kolekci a prostředí.
cd C:\Users\Asus\Desktop\Postman Tutorial
Krok 9) Spusťte svou sbírku pomocí tohoto příkazu:
newman run PostmanTestCollection.postman_collection.json -e Testing.postman_globals.json
Výsledky běhu by nyní měly vypadat jako níže.
Pro průvodce je odkaz na některé základní Newmanovy kódy pro spuštění:
- Spusťte pouze sbírku. To lze použít, pokud neexistuje žádná závislost na prostředí nebo testovacím datovém souboru.
- Spusťte sbírku a prostředí. Indikátor -e je pro prostředí.
- Spusťte sbírku s požadovaným číslem iterací.
- Spustit s datovým souborem.
- Nastavte čas zpoždění. To je důležité, protože testy mohou selhat, pokud jsou spuštěny bez prodlení, protože požadavky byly spuštěny, aniž by předchozí požadavek dokončil zpracování na serveru koncového bodu.
newman run <collection name>
newman run <collection name> -e <environment name>
newman run <collection name> -n <no.of iterations>
newman run <collection name> --data <file name> -n <no.of iterations> -e <environment name>
newman run <collection name> -d <delay time>
Náš Postman průvodce otázkami na pohovor vám pomůže prolomit pohovor a pomůže vám získat vysněnou práci na testování softwaru.
Shrnutí
- Testování API pomocí Postman: Postman je aplikace pro testování API. Postman je jedním z nejpopulárnějších nástrojů používaných při testování API odesíláním požadavků na webový server a získáváním zpětné odpovědi
- Přístupnost, používání sbírek, spolupráce, průběžná integrace, to jsou některé z klíčových funkcí, které je třeba se naučit Postman
- Doporučuje se vytvořit účet v Postman, takže vaše sbírky jsou dostupné online
- Požadavek můžete parametrizovat v Postman
- Pro ověření požadavku pošťáka můžete vytvořit testy
- Sbírky lze spouštět pomocí Newman nebo Collection Runner