Postman je softvér, ktorý môžete použiť na testovanie rozhraní REST API. Poštár má ľahko použiteľné grafické užívateľské rozhranie. Má tiež veľa užitočných funkcií, ktoré vám pomôžu s testovaním rozhrania REST API.  Postman je k dispozícii pre Windows, Mac a Linux. Postman je k dispozícii aj ako doplnok pre Chrome. Aplikáciu Postman teda môžete používať vo svojom prehliadači Google Chrome. Poštár má bezplatnú verziu a platenú verziu. S bezplatnou verziou môžete robiť takmer všetko. Bezplatnú verziu použijem v tomto článku.

V tomto článku vám ukážem, ako otestovať rozhranie REST API pomocou aplikácie Postman. Začnime.

Inštalácia aplikácie Postman ako rozšírenia pre Chrome:

V tejto časti si ukážem, ako nainštalovať Postman z Internetového obchodu Chrome.

Najskôr prejdite na stránku s rozšírením Postman v Internetovom obchode Chrome na adrese https: // chrome.google.com / webový obchod / detail / poštár / fhbjgbiflinjbdggehcddcbncdddomop?hl = sk

Teraz kliknite na Pridať do prehliadača Chrome.

Teraz kliknite na Pridať aplikáciu.

Poštár by mal byť nainštalovaný. Teraz môžete kliknúť na Spustiť aplikáciu spustiť Poštára.

Alebo môžete kliknúť na Aplikácie.

A odtiaľ začnite Poštára.

Ak otvoríte program Poštár po prvýkrát, malo by sa zobraziť nasledujúce okno. Ak nemáte účet alebo sa nechcete prihlásiť, kliknite na odkaz označený na snímke obrazovky nižšie.

Poštár by mal začať.

Hlavné okno poštára:

Môžete tiež natívne nainštalovať Postman na Linux. Je to mimo rozsahu tohto článku. Takže to tu nemôžem ukázať.

Nastavenie testovacieho servera API:

Napísal som API pomocou Node.js, ktoré budem v tomto článku používať, aby som vám ukázal, ako používať program Postman na testovanie rozhraní API. Ak chcete postupovať ďalej, stačí naklonovať moje úložisko GitHub angular-hero-api a spustiť rovnaký server API ako ja.

Klonujte moje úložisko GitHub pomocou nasledujúceho príkazu:

$ git klon https: // github.com / shovon8 / angular-hero-api

Teraz prejdite na ikonu angular-hero-api / adresár:

$ cd angular-hero-api /

Teraz nainštalujte všetky požadované moduly uzlov:

$ npm inštalácia

Nakoniec spustite server API nasledujúcim príkazom:

$ npm test

Ako vidíte, server API je spustený na porte 4242.

Základy poštára:

Najskôr otvorte Poštára a malo by to vyzerať asi takto.

Do označenej časti snímky obrazovky nižšie môžete zadať adresu URL svojho koncového bodu API.

Z rozbaľovacej ponuky označenej na snímke obrazovky nižšie môžete zvoliť metódu žiadosti (napríklad GET, POST, PUT atď.).

Po dokončení kliknite na Pošli na odoslanie vašej požiadavky API. Výsledok by sa mal zobraziť.

Ako všetko funguje, uvidíte v nasledujúcej časti tohto článku.

Používanie programu Postman na testovanie rozhraní REST API:

Ak chcete na svojom API vykonať požiadavku GET, zadajte adresu URL svojho koncového bodu API, nastavte metódu na ZÍSKAJTE, a nakoniec klikni na Pošli.

Napríklad ak chcete získať zoznam všetkých hrdinov v databáze, urobte a ZÍSKAJTE požiadavka na server API / api / hrdinovia koncový bod. Akonáhle stlačíte Pošli, výstup by sa mal zobraziť vo formáte JSON, ako vidíte na snímke obrazovky nižšie.

Môžete tiež urobiť požiadavku POST na serveri API pomocou aplikácie Postman. Nastavil som svoj API server tak, aby vytvoril nový Hero na POST požiadavku. Ak chcete vytvoriť nového hrdinu, nastavte metódu na POST a koncový bod API do / api / hrdinov; Potom kliknite na Telo ako je vyznačené na snímke obrazovky nižšie.

Teraz kliknite na surový a vyberte JSON (aplikácia / json) z rozbaľovacej ponuky typu označenej na snímke obrazovky nižšie.

Nakoniec zadajte informácie o hrdinovi, ktorého chcete vložiť, vo formáte JSON a kliknite na Pošli.

Ako vidíte, Hero je vložený s id 21.

Všetky vaše požiadavky API, ktoré urobíte, sa uložia do histórie Poštára. Ak chcete použiť žiadosť o API z histórie, jednoducho na ňu kliknite a potom kliknite na Pošli.

Ako vidíte, požiadavka API na zoznam všetkých hrdinov, ktorých sme predtým vykonali, je uvedená v histórii. Po kliknutí na ňu by sa mala otvoriť na novej karte. Nakoniec kliknite na Pošli.

Ako vidíte, všetci hrdinovia sú uvedení v zozname vrátane nášho nového hrdinu.

Hrdinu môžete zo zoznamu tiež vymazať pomocou ODSTRÁNIŤ metóda na / api / hrdina / koncový bod. Tu, je ID hrdinu, ktorého chcete odstrániť.

Povedzme, že chcete odstrániť Hero s id 20. Koncový bod API teda je / api / hrdina / 20 a metóda je ODSTRÁNIŤ. Ako vidíte, a úspech správa sa vráti. Hrdina by mal byť vymazaný.

Ako vidíte, Hero s ID 20 je vymazaný.

Predtým som vám ukázal, ako poslať informácie vo formáte JSON na server API. Tu vám ukážem, ako posielať informácie vo formáte kódovanom URL. Pri odosielaní formulára HTML na server sa predvolene používa tento formát.

Povedzme, že chcete aktualizovať Hero v API servera. Ak to chcete urobiť, musíte použiť PATCH metóda zapnutá / api / hrdina / koncový bod, pretože to je to, čo som nakonfiguroval na svojom serveri API. Tu je je ID hrdinu, ktorého chcete aktualizovať.

Napríklad, zmeňme meno hrdinu s id 19 z Magma do Batman. Koncový bod API by teda mal byť / api / hrdina / 19 a metóda by mala byť PATCH. Teraz kliknite na Telo a tiež vyberte x-www-form-urlencoded ako je vyznačené na snímke obrazovky nižšie.

Teraz nastavte kľúč na názov a hodnotu pre Batman ako je vyznačené na snímke obrazovky nižšie. Nakoniec kliknite na Pošli.

Ako vidíte, aktualizované údaje sa zobrazia. Čo znamená, že operácia aktualizácie je úspešná.

Ak znova uvediete všetkých hrdinov, mali by ste vidieť aktualizované údaje, ako vidíte na snímke obrazovky nižšie.

To je teda základ Postmana. Poštár má kopu funkcií a možností, pomocou ktorých si uľahčíte život ako vývojár API. Ďakujeme, že ste si prečítali tento článok. Bavte sa so svojím poštárom!