API REST

Testiranje API-ja REST z uporabo poštarja

Testiranje API-ja REST z uporabo poštarja
Postman je programska oprema, s katero lahko preizkusite REST API-je. Poštar ima preprost grafični uporabniški vmesnik. Ima tudi veliko koristnih funkcij, ki vam pomagajo pri preizkušanju vašega API-ja REST.  Poštar je na voljo za Windows, Mac in Linux. Poštar je na voljo tudi kot vtičnik za Chrome. Torej lahko v brskalniku Google Chrome uporabite Postman. Poštar ima brezplačno različico in plačljive različice. Z brezplačno različico lahko storite skoraj vse. V tem članku bom uporabil brezplačno različico.

V tem članku vam bom pokazal, kako preizkusiti REST API s pomočjo Postman. Začnimo.

Namestitev Postman-a kot razširitve za Chrome:

V tem razdelku vam bom pokazal, kako namestite Postman iz spletne trgovine Chrome.

Najprej pojdite na razširitveno stran Postman v spletni trgovini Chrome na naslovu https: // chrome.google.com / webstore / detail / postman / fhbjgbiflinjbdggehcddcbncdddomop?hl = sl

Zdaj kliknite na Dodaj v Chrome.

Zdaj kliknite Dodaj aplikacijo.

Namestiti je treba poštarja. Zdaj lahko kliknete na Zagon aplikacije začeti Poštar.

Lahko pa kliknete Aplikacije.

In začni Poštarja od tam.

Če poštar odprete prvič, se prikaže naslednje okno. Kliknite povezavo, kot je označena na spodnjem posnetku zaslona, ​​če nimate računa ali se ne želite prijaviti.

Poštar bi moral začeti.

Glavno okno poštarja:

Postman lahko namestite tudi v Linuxu. Ta člen ne spada v področje uporabe. Torej, tukaj je ne morem pokazati.

Nastavitev testnega strežnika API:

API sem napisal z uporabo Node.js, ki ga bom uporabil v tem članku, da vam pokažem, kako uporabljati Postman za testiranje API-jev. Če želite nadaljevati, lahko samo klonirate moje skladišče GitHub kotni-junak-api in zaženite isti strežnik API kot jaz.

Klonirajte moje skladišče GitHub z naslednjim ukazom:

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

Zdaj se pomaknite do angular-hero-api / imenik:

$ cd angular-hero-api /

Zdaj namestite vse zahtevane module vozlišča:

$ npm namestitev

Na koncu zaženite strežnik API z naslednjim ukazom:

$ npm test

Kot lahko vidite, strežnik API deluje na vratih 4242.

Osnove poštarja:

Najprej odprite Poštarja in videti bi moralo biti približno tako.

V označeni del spodnjega posnetka zaslona lahko vnesete URL končne točke API-ja.

Način zahteve (npr. GET, POST, PUT itd.) Lahko izberete v spustnem meniju, kot je označeno na spodnjem posnetku zaslona.

Ko končate, kliknite Pošlji da pošljete svojo zahtevo za API. Rezultat bi moral biti prikazan.

Kako vse deluje, boste videli v naslednjem poglavju tega članka.

Uporaba poštarja za testiranje API-jev REST:

Če želite na svojem API-ju izvesti zahtevo GET, vnesite URL končne točke API-ja in nastavite metodo na GET, in končno kliknite na Pošlji.

Če želite na primer dobiti seznam vseh junakov v zbirki podatkov, naredite a GET zahteva do strežnika API / api / junaki končna točka. Ko pritisnete Pošlji, izhod naj bo prikazan v obliki JSON, kot lahko vidite na spodnjem posnetku zaslona.

Zahtevo POST lahko naredite tudi na strežniku API s pomočjo Postman. Strežnik API sem nastavil tako, da na zahtevo POST ustvari novega junaka. Če želite ustvariti novega junaka, nastavite metodo na OBJAVI in končna točka API v / api / junaki; Nato kliknite Telo kot je označeno na spodnjem posnetku zaslona.

Zdaj kliknite surov in izberite JSON (application / json) iz spustnega menija vrste, kot je označeno na spodnjem posnetku zaslona.

Na koncu vnesite podatke o junaku, ki ga želite vstaviti v format JSON, in kliknite Pošlji.

Kot lahko vidite, je Hero vstavljen z id 21.

Vse vaše zahteve za API se shranijo v zgodovino poštarja. Če želite uporabiti zahtevo za API iz zgodovine, jo preprosto kliknite in nato kliknite Pošlji.

Kot lahko vidite, je zahteva API za seznam vseh junakov, ki smo jih naredili prej, navedena v zgodovini. Ko ga kliknete, se mora odpreti v novem zavihku. Na koncu kliknite Pošlji.

Kot lahko vidite, so navedeni vsi Heroji, vključno z našim novim Herojem.

Hero lahko s seznama tudi izbrišete s pomočjo IZBRIŠI metoda na / api / hero / končna točka. Tukaj, je id junaka, ki ga želite izbrisati.

Recimo, da želite odstraniti Heroja z id 20. Končna točka API je torej / api / hero / 20 in metoda je IZBRIŠI. Kot lahko vidite, a uspeh sporočilo se vrne. Heroja je treba izbrisati.

Kot lahko vidite, je Hero z id 20 izbrisan.

Prej sem vam pokazal, kako na API strežnik pošiljati informacije v obliki JSON. Tukaj vam bom pokazal, kako pošiljate informacije v obliki zapisa, kodiranem z URL-ji. Ko strežniku oddate obrazec HTML, je ta oblika privzeto uporabljena.

Recimo, da želite posodobiti Hero v API strežniku. Če želite to narediti, morate uporabiti PATCH metoda na / api / hero / končno točko, saj sem to konfiguriral v strežniku API. Tukaj je ID junaka, ki ga želite posodobiti.

Na primer, spremenimo ime junaka z id 19 iz Magma do Batman. Torej, končna točka API bi morala biti / api / hero / 19 in metoda mora biti PATCH. Zdaj kliknite Telo in tudi izberite x-www-form-urlencoded kot je označeno na spodnjem posnetku zaslona.

Zdaj nastavite ključ na ime in vrednost do Batman kot je označeno na spodnjem posnetku zaslona. Na koncu kliknite Pošlji.

Kot vidite, se prikažejo posodobljeni podatki. Kar pomeni, da je bila operacija posodobitve uspešna.

Če znova navedete vse junake, boste videli posodobljene podatke, kot jih vidite na spodnjem posnetku zaslona.

Torej, to so osnove poštarja. Postman ima na voljo številne funkcije in možnosti, s katerimi si lahko olajšate življenje kot razvijalec API-jev. Hvala, ker ste prebrali ta članek. Zabavajte se s svojim poštarjem!

Vadnica za OpenTTD
OpenTTD je ena izmed najbolj priljubljenih poslovnih simulacijskih iger. V tej igri morate ustvariti čudovit prevozniški posel. Vendar boste začeli na...
SuperTuxKart za Linux
SuperTuxKart je odličen naslov, zasnovan tako, da vam brezplačno ponuja izkušnjo Mario Kart v vašem sistemu Linux. Igrati je precej zahtevno in zabavn...
Vadnica za bitko za Wesnoth
Bitka za Wesnoth je ena izmed najbolj priljubljenih odprtokodnih strateških iger, ki jih lahko trenutno igrate. Ne samo, da se ta igra razvija že zelo...