Selles artiklis näitan teile, kuidas testida REST API-d Postmani abil. Alustame.
Postmani installimine Chrome'i laiendina:
Selles jaotises näitan teile, kuidas installida Postman Chrome'i veebipoest.
Kõigepealt minge Chrome'i veebipoes Postmani laienduse lehele aadressil https: // chrome.google.com / webstore / detail / postman / fhbjgbiflinjbdggehcddcbncdddomop?hl = et
Nüüd klõpsake nuppu Lisage Chrome'i.
Nüüd klõpsake nuppu Lisa rakendus.
Postimees tuleks paigaldada. Nüüd saate klõpsata nupul Käivitage rakendus Postimehe käivitamiseks.
Või võite klõpsata nupul Rakendused.
Ja alustage sealt Postmani.
Kui avate Postmani esimest korda, peaksite nägema järgmist akent. Kui teil pole kontot või te ei soovi sisse logida, klõpsake alloleval ekraanipildil märgitud lingil.
Postimees peaks alustama.
Postimehe peaaken:
Postmani saab ka Linuxi sisse installida. See jääb selle artikli reguleerimisalast välja. Nii et ma ei saa seda siin näidata.
Testi API serveri seadistamine:
Olen sõlme abil kirjutanud API.js, mida ma selles artiklis kasutan, et näidata teile, kuidas Postmani kasutada API-de testimiseks. Kui soovite kaasa minna, võite lihtsalt kloonida minu GitHubi hoidla nurgeline-kangelane-api ja käivita sama API server nagu ma olen.
Kloonige minu GitHubi hoidla järgmise käsuga:
$ giti kloon https: // github.com / shovon8 / nurk-kangelane-api
Nüüd navigeerige jaotisesse nurgeline-kangelane-api / kataloog:
$ cd nurk-kangelane-api /
Nüüd installige kõik vajalikud sõlmede moodulid:
$ npm install
Lõpuks käivitage API-server järgmise käsuga:
$ npm testNagu näete, töötab API server pordis 4242.
Postimehe põhitõed:
Esiteks avage Postimees ja see peaks välja nägema umbes selline.
Allpool oleva ekraanipildi märgitud jaotisse saate sisestada oma API-lõpp-punkti URL-i.
Taotlusmeetodi (nt GET, POST, PUT jne) saate valida rippmenüüst, nagu on märgitud alloleval ekraanipildil.
Kui olete valmis, klõpsake nuppu Saada oma API taotluse saatmiseks. Tulemus tuleks kuvada.
Kuidas kõik töötab, näete selle artikli järgmises jaotises.
Postimehe kasutamine REST-i API-de testimiseks:
Kui soovite oma API-l GET-päringut täita, sisestage oma API-lõpp-punkti URL, määrake meetodiks Hangi, ja lõpuks klõpsake nuppu Saada.
Näiteks kõigi andmebaasis olevate kangelaste loendi saamiseks tehke järgmist Hangi taotlus API-serverile / api / kangelased lõpp-punkt. Kui olete vajutanud Saada, väljund peaks olema kuvatud JSON-vormingus, nagu näete alloleval ekraanipildil.
Postimehe abil saate POST-päringu teha ka oma API-serveris. Seadistasin oma API-serveri nii, et see loob POST-i nõudmisel uue kangelase. Uue kangelase loomiseks määrake meetodiks POSTITA ja API lõpp-punkt to / api / kangelastele; Seejärel klõpsake nuppu Keha nagu on märgitud alloleval ekraanipildil.
Nüüd klõpsake nuppu toores ja valige JSON (taotlus / json) tüübi rippmenüüst, nagu on märgitud alloleval ekraanipildil.
Lõpuks sisestage JSON-vormingus sisestatava kangelase teave ja klõpsake nuppu Saada.
Nagu näete, lisatakse kangelane ID-ga 21.
Kõik teie taotletud API-taotlused salvestatakse Postmani ajalukku. Ajaloo API-päringu kasutamiseks klõpsake lihtsalt seda ja seejärel klõpsake nuppu Saada.
Nagu näete, on API taotlus loetleda kõik kangelased, mida me varem tegime, ajaloos. Kui olete sellel klõpsanud, peaks see avanema uuel vahelehel. Lõpuks klõpsake nuppu Saada.
Nagu näete, on loetletud kõik kangelased, sealhulgas meie uus kangelane.
Kangelase saate loendist ka kustutada, kasutades nuppu KUSTUTA meetod / api / hero /
Oletame, et soovite eemaldada kangelase ID-ga 20. Nii et API lõpp-punkt on / api / kangelane / 20 ja meetod on KUSTUTA. Nagu näete, a edu teade tagastatakse. Kangelane tuleks kustutada.
Nagu näete, kustutatakse kangelane ID-ga 20.
Varem näitasin teile, kuidas JSON-vormingus teavet API-serverile saata. Siin ma näitan teile, kuidas saata teavet URL-i kodeeritud vormingus. HTML-vormi serverisse esitamisel kasutatakse seda vormingut vaikimisi.
Oletame, et soovite värskendada kangelast serveris API-s. Selleks peate kasutama Plaaster meetod / api / kangelane /
Muutkem näiteks kangelase nimi ID-ga 19 alates Magma kuni Batman. Niisiis, API lõpp-punkt peaks olema / api / kangelane / 19 ja meetod peaks olema Plaaster. Nüüd klõpsake nuppu Keha ja valige ka x-www-vorm-urlenkodeeritud nagu on märgitud alloleval ekraanipildil.
Nüüd määrake võti nimi ja väärtus Batman nagu on märgitud alloleval ekraanipildil. Lõpuks klõpsake nuppu Saada.
Nagu näete, kuvatakse värskendatud andmed. Mis tähendab, et värskendustoiming on edukas.
Kui loete kõik kangelased uuesti üles, peaksite nägema värskendatud andmeid, nagu näete alloleval ekraanipildil.
Nii, see on Postimehe põhitõed. Postimehel on palju funktsioone ja võimalusi, mille abil saate oma elu API-arendajana lihtsustada. Täname, et lugesite seda artiklit. Nautige oma Postimehega!