V tomto článku vám ukážu, jak otestovat rozhraní REST API pomocí nástroje Postman. Začněme.
Instalace aplikace Postman jako rozšíření pro Chrome:
V této části vám ukážu, jak nainstalovat Postman z Internetového obchodu Chrome.
Nejprve přejděte na stránku rozšíření Postman v Internetovém obchodě Chrome na adrese https: // chrome.Google.com / webový obchod / detail / pošťák / fhbjgbiflinjbdggehcddcbncdddomop?hl = cs
Nyní klikněte na Přidat do Chromu.
Nyní klikněte na Přidat aplikaci.
Postman by měl být nainstalován. Nyní můžete kliknout na Spusťte aplikaci spustit Pošťáka.
Nebo můžete kliknout na Aplikace.
A odtud spusťte Postmana.
Pokud otevřete Postmana poprvé, mělo by se zobrazit následující okno. Pokud nemáte účet nebo se nechcete přihlásit, klikněte na odkaz označený na snímku obrazovky níže.
Pošťák by měl začít.
Hlavní okno pošťáka:
Postman můžete také nainstalovat nativně na Linux. Je to mimo rozsah tohoto článku. Tady to tedy nejsem schopen ukázat.
Nastavení testovacího serveru API:
Napsal jsem API pomocí Node.js, které v tomto článku použiji, abych vám ukázal, jak používat Postman k testování API. Pokud chcete pokračovat, můžete klonovat moje úložiště GitHub úhlový hrdina-api a spustit stejný server API jako já.
Klonujte mé úložiště GitHub pomocí následujícího příkazu:
$ git clone https: // github.com / shovon8 / angular-hero-api
Nyní přejděte na angular-hero-api / adresář:
$ cd angular-hero-api /
Nyní nainstalujte všechny požadované moduly uzlů:
$ npm instalace
Nakonec spusťte server API následujícím příkazem:
$ npm testJak vidíte, server API běží na portu 4242.
Základy pošťáka:
Nejprve otevřete Postmana a měl by vypadat nějak takto.
Do označené části obrazovky níže můžete zadat adresu URL svého koncového bodu API.
Z rozevírací nabídky můžete vybrat metodu požadavku (například GET, POST, PUT atd.), Jak je označeno na následujícím obrázku.
Až budete hotovi, klikněte na Poslat k odeslání požadavku API. Výsledek by se měl zobrazit.
Jak vše funguje, uvidíte v další části tohoto článku.
Použití nástroje Postman k testování rozhraní REST API:
Pokud chcete na svém API provést požadavek GET, zadejte adresu URL svého koncového bodu API, nastavte metodu na DOSTAT, a nakonec klikněte na Poslat.
Chcete-li například získat seznam všech hrdinů v databázi, proveďte a DOSTAT požadavek na server API / api / hrdinové koncový bod. Jakmile stisknete Poslat, výstup by měl být zobrazen ve formátu JSON, jak vidíte na následujícím obrázku.
Můžete také provést požadavek POST na serveru API pomocí Postmana. Nastavil jsem svůj server API takovým způsobem, že na vyžádání POST vytvoří nového Hero. Chcete-li vytvořit nového hrdinu, nastavte metodu na POŠTA a koncový bod API do / api / hrdinové; Poté klikněte na Tělo jak je uvedeno na snímku obrazovky níže.
Nyní klikněte na drsný a vyberte JSON (aplikace / json) z rozevírací nabídky typu, jak je uvedeno na obrázku níže.
Nakonec zadejte informace o hrdinovi, kterého chcete vložit ve formátu JSON, a klikněte na Poslat.
Jak vidíte, Hero je vložen s id 21.
Všechny vaše požadavky API, které zadáte, se uloží do historie Postmana. Chcete-li použít požadavek API z historie, stačí na něj kliknout a poté kliknout na Poslat.
Jak vidíte, požadavek API na seznam všech hrdinů, které jsme udělali dříve, je uveden v historii. Jakmile na něj kliknete, mělo by se otevřít na nové kartě. Nakonec klikněte na Poslat.
Jak vidíte, jsou zde uvedeny všichni hrdinové, včetně našeho nového hrdiny.
Hrdinu můžete ze seznamu také odstranit pomocí VYMAZAT metoda na / api / hrdina /
Řekněme tedy, že chcete odstranit Hero s id 20. Koncový bod API tedy je / api / hrdina / 20 a metoda je VYMAZAT. Jak vidíte, a úspěch zpráva je vrácena. Hrdina by měl být odstraněn.
Jak vidíte, Hero s id 20 je smazán.
Dříve jsem vám ukázal, jak odeslat informace ve formátu JSON na server API. Tady vám ukážu, jak posílat informace ve formátu kódovaném URL. Když odešlete formulář HTML na server, jedná se o formát používaný ve výchozím nastavení.
Řekněme, že chcete aktualizovat Hero v API na serveru. K tomu musíte použít NÁPLAST metoda na / api / hrdina /
Například změňme jméno hrdiny s ID 19 z Magma na Bat-man. Koncový bod API by tedy měl být / api / hrdina / 19 a metoda by měla být NÁPLAST. Nyní klikněte na Tělo a také vyberte x-www-form-urlencoded jak je uvedeno na snímku obrazovky níže.
Nyní nastavte klíč na název a hodnotu pro Bat-man jak je uvedeno na snímku obrazovky níže. Nakonec klikněte na Poslat.
Jak vidíte, zobrazí se aktualizovaná data. Což znamená, že operace aktualizace je úspěšná.
Pokud znovu uvedete všechny hrdiny, měli byste vidět aktualizovaná data, jak vidíte na následujícím obrázku.
To je tedy základ Postmana. Postman má spoustu funkcí a možností, které můžete použít, abyste si ulehčili život vývojáře API. Děkujeme za přečtení tohoto článku. Bavte se se svým pošťákem!