Kaip lengvai išbandyti ir žaisti su žiniatinklio API su paštininku

Pasaulyje, kuriame statiškos svetainės ir programos vis labiau priklauso nuo atskirai prižiūrimų API, gali būti sunku suprasti, kaip jie veikia, tiesiog žaisdami naršyklėje.

Taigi, kaip mes galime naudoti „Postman“, norėdami išbandyti esamas API ir suprasti, kaip jie veikia?

  • Kas yra paštininkas?
  • Ką mes kursime / mokysimės?
  • 0 dalis: Susikūrimas su paštininku
  • 1 dalis. Įvadas į paštininką
  • 2 dalis: naujos paštininkės užklausos, kad gautumėte informacijos apie „Squirtle“, sukūrimas
  • 3 dalis. „Pokman“ programos „Postman“ užklausų rinkinio kūrimas
  • 4 dalis: Pateikti POST užklausas su „Postman“, kad sakiniai būtų išversti į „Yoda“
  • 5 dalis. Prašymų tikrinimas „Žiedų valdovo“ API su API raktu

Kas yra paštininkas?

„Postman“ yra įrankis, kuriuo komandos gali patikimai išbandyti API naudodamos lengvai naudojamas konfigūracijas. Jame yra funkcijų, kurių galite tikėtis dirbdami su API, įskaitant autentifikavimą, antraščių nustatymą, naudingosios apkrovos tinkinimą ir dar daugybę kitų, kurie padeda sumažinti API naudojimo trintį.

Ir tai ne tik bandymams. Gražiausia yra tai, kad tai gali būti naudojama daugeliui darbo su API aspektų daugeliui komandos narių. Galbūt projektų vadovas nori patikrinti, ar viskas veikia, ar gali būti lengviau atlikti pakeitimus tiesiogiai naudojant API, arba kokybės užtikrinimo inžinierius turi įsitikinti, kad viskas vis dar veikia, arba kūrėjas nori aktyviai atlikti pakeitimus dirbdamas su pačia API .

Geriausia tai - „Postman“ teikia bendradarbiavimo funkcijas. Nemokama pakopa apima išsaugotų API užklausų kolekcijų eksportavimą ir importavimą bei bendrų nuorodų kūrimą. Jei esate komandos narys, jie turi mokamas pakopas, leidžiančias sinchronizuoti savo kolekcijas, kad įsitikintumėte, jog visi turi naujausią ir naujausią kolekciją.

Ką mes kursime / mokysimės?

Apžvelgsime du skirtingus API pavyzdžius, kad aptartume „Postman“ sąvokas.

Pirmiausia, mes atliksime paprastas HTTP užklausas naudodami viešą „Pokemon“ API.

Tada vienoje dalyje naudosime „Yoda Translator“ API, kad parodytume, kaip pateikti konkrečias HTTP užklausas.

Supratę, kaip veikia pagrindai, naudosime „Žiedų valdovo“ API, kad sužinotume, kaip autentifikavimas veikia su API. Norėdami tai padaryti, turėsite užsiregistruoti gauti nemokamą API rakto paskyrą.

0 dalis: Susikūrimas su paštininku

Prieš pradėdami, jums reikės paštininko, kad galėtumėte sekti šį žingsnį. Geros naujienos yra tai, kad „Postman“ galima nemokamai įsigyti „Mac“, „Windows“ ir „Linux“, todėl turėtumėte sugebėti rasti jums tinkančią versiją.

Gaukite paštininką: //www.postman.com/downloads/

Atsisiųsdami atlikite standartines diegimo instrukcijas, atidarykite jas ir turėtume būti pasirengę eiti!

1 dalis. Įvadas į paštininką

Pirmą kartą atidarę „Postman“, jums nedelsiant bus rodoma paleidimo pultas su daugybe galimybių pradėti.

Tai gali atrodyti šiek tiek pribloškianti, tačiau suskirstykime keletą pagrindinių sąvokų, kurias turėsime žinoti.

Prašymai

Prašymas yra panašus į tai, kaip jis skamba, tai yra specifinė API užklausa. Tai bus vieno tipo užklausa, nesvarbu, ar tai GET, ar POST tam tikram tikslui. Kiekvienam galinio taško tipui norėsite sukurti naujas užklausas, kurios leis jums pereiti tarp jų bandant.

Kolekcijos

Kolekcija yra užklausų grupė. Tai patogu organizuoti užklausas į skirtingas grupes. Tai gali būti taip paprasta, kaip dvi visiškai skirtingos API (ty „Twitter“ ir „Slack“), arba tai gali būti dvi skirtingos API grupės vienai API (ty „Twitter Tweets API“ ir „Twitter Accounts“ API).

Leidimas

Įgaliojimas yra tai, kaip užklausos yra tikrinamos naudojant API, tai gali padaryti asmuo, pateikiantis užklausą, arba kompiuteris, pateikiantis šią užklausą jūsų vardu. Tai paprastai pateikiama kaip API raktas, kuris gali būti statinė vertė, priskirta jūsų paskyrai, arba dinamiškai sugeneruota naudojant tokius įrankius kaip „OAuth“.

Aplinkos

Aplinkos leis jums sukonfigūruoti savo taškus naudoti tam tikrus kintamuosius, kurie palengvins tų pačių taškų naudojimą skirtingose ​​aplinkose. Pavyzdžiui, galite turėti tą patį /profilegalinį rezultatą tiek savo gamybos, tiek kūrimo aplinkoje, tačiau jie turi skirtingas sritis. Aplinkos leidžia valdyti vieną užklausą su kintamu domenu.

Darbo vietos

Šiame įraše per daug nenagrinėsime darbo vietų, tačiau tai leidžia jums tvarkyti ir tvarkyti skirtingus kolekcijų rinkinius. Įsivaizduokite, jei norite naudoti „Postman“ darbui ir asmeniniam projektui, galite turėti darbo ir asmeninę darbo sritį.

Šiame straipsnyje aptarsime užklausas, rinkinius ir įgaliojimus.

2 dalis: naujos paštininkės užklausos, kad gautumėte informacijos apie „Squirtle“, sukūrimas

Dabar, kai geriau suprasime skirtingą terminologiją, iš tikrųjų sukurkime užklausą.

Vartotojo sąsajos viršuje, kairėje, turėtumėte pamatyti tik oranžinį mygtuką, kuriame parašyta Nauja . Pirmyn spustelėkite ir spustelėkite užklausą .

Prieš pradedant patį prašymą, jis reikalauja kelių dalykų.

Pirmiausia reikalingas vardas. Pirmiausia prašysime informacijos apie „Pokémon Squirtle“, todėl pavadinkime tai „Pokémon - Squirtle“.

Tam taip pat reikalinga kolekcija, todėl spustelėkite „ Sukurti kolekciją“ ir pavadinkime kolekciją pavadinimu „Mano mėgstamiausias„ Pokemon ““.

Spustelėkite oranžinį žymės mygtuką šalia kolekcijos pavadinimo, tada paspauskite Išsaugoti .

Šiuo metu turėsime naują užklausą, todėl sukurkime tą užklausą.

Pirmiausia turime užpildyti du dalykus, kad gautume pirmąją užklausą:

  • Užklausos tipas: GET, POST, PUT ir tt - naudosime GET
  • Užklausos URL: jūsų API užklausos galas - užklausai naudosime //pokeapi.co/api/v2/pokemon/squirtle/

Ir kai jūs įsitikinkite, kad jie yra teisingi, galite tiesiog paspausti mėlyną Siųsti mygtuką dešinėje ir sėkmingai padarė savo pirmąjį prašymą!

Iš karto gauname keletą dalykų, kuriuos galime pamatyti:

  • Turinys: apačioje dabar turėtume pamatyti API užklausos atsakymą. Mūsų Squirtle API, turėtume turėti JSON objektą su duomenimis kaip abilities, base_experienceir forms.
  • Būsena: dešinėje turėtume pamatyti HTTP būsenos kodą. „200 Ok“ yra geras ženklas ir tai reiškia, kad jis buvo sėkmingas!
  • Laikas: paprasčiausiai, kiek laiko praėjo prašymas
  • Dydis: atsakymo duomenų dydis KB (mūsų pavyzdyje)

Taip pat galite užvesti pelės žymeklį virš būsenos, laiko ir dydžio ir išsamiau apžvelgti kiekvieną parinktį.

Taigi mes pateikėme savo pirmąjį prašymą!

Vienas dalykas, kurį reikia pastebėti prieš pereinant, yra tai, kad mūsų užklausa atrodo kaip naršyklės skirtuke. Jei baigsime konkrečią užklausą, galime uždaryti skirtuką ir spustelėti Išsaugoti, kad įsitikintume, jog visi mūsų pakeitimai bus atlikti kitą kartą!

3 dalis. „Pokman“ programos „Postman“ užklausų rinkinio kūrimas

Sukūrę užklausą, sukurkime jų kolekciją. Techniškai jau turėjome sukurti naują 2 dalies kolekciją, tačiau sukursime naują, kad sužinotume, kaip veikia pačios kolekcijos.

Vartotojo sąsajos viršuje kairėje dar kartą spustelėkite oranžinį mygtuką Naujas ir pasirinkite Kolekcija .

Panašiai kaip užklausoje, joje prašoma pavadinimo, vadinkime tai „PokéAPI“. Pasirinktinai galite pridėti aprašą, tada apačioje spustelėkite Kurti .

Kairėje dabar pamatysite savo kolekciją. Galite pasirinkti ir išplėsti aplanką, nes mes su juo dirbsime.

Prieš pridėdami užklausą, „PokéAPI“ turi skirtingų tipų užklausas, todėl tikslinga ją organizuoti šiek tiek nuodugniau. Taigi spustelėkite tris taškus šalia „PokéAPI“ kolekcijos ir pasirinkite Pridėti aplanką .

Panašiai kaip ir kiti, taip prašoma pavadinimo. Aplankai yra tarsi kolekcijos viduje esančios kolekcijos, todėl jūs gaunate panašias parinktis. Pavadinkime tai „Pokemon“ ir spustelėkite oranžinį mygtuką „ Išsaugoti “, kaip ir anksčiau.

Dabar pridėkime savo prašymus! Pirmiausia spustelėkite tris taškus šalia „Pokémon“ aplanko, panašiai kaip pridėjome aplanką prie kolekcijos, bet šį kartą pasirinkite Pridėti užklausą .

Pavadinkime šią užklausą „Pokemon“. Nors gali būti painu, kad „Pokemon“ aplanke turime „Pokemon“ užklausą, „Pokemon“ yra tik vienas iš „Pokemon“ grupės galinių taškų.

Dabar naudokime tą patį tikslų API, kurį anksčiau naudojome su „Squirtle“ užklausa:

  • Užklausos tipas: GET
  • Užklausos URL: //pokeapi.co/api/v2/pokemon/squirtle/

Ir panašiai kaip anksčiau, kai paspausime mėlyną mygtuką „ Siųsti “, turėtume pamatyti sėkmingą užklausą!

Dabar pridėkime dar vieną užklausą. Laikykitės to paties proceso, kaip ir anksčiau, kad sukurtumėte naują užklausą aplanke „PokéAPI Pokémon“ ir pavadinkime šią užklausą „Gebėjimais“.

Jei slinksite atsakymą iš pirmojo „Squirtle“ galinio taško, pamatysite daug kitų API URL. Viršuje turime abilitiesir turime du skirtingus - „torrent“ ir „rain-dish“.

Pasirinkite mėgstamiausią „Squirtle“ galimybę ir nukopijuokite urlvertę į naują ką tik sukurtą „Abilities“ užklausą, kurią naudosiu rain-dish.

Mes galime palikti užklausos tipą kaip GET, paspausti mėlyną mygtuką „ Siųsti “ ir vėl galime pamatyti sėkmingą atsakymą!

Čia mes gauname daug informacijos apie mūsų „Squirtle“ galimybes „Rain Dish“, o kai kurios detalės pateikiamos skirtingomis kalbomis, o tai yra puiku!

Taigi dabar turime naują „PokéAPI“ kolekciją su „Pokémon“ aplanku, vaizduojančiu „Pokémon“ API galinių taškų grupę, įskaitant „Pokemon“ ir sugebėjimus.

Mes sustabdysime 3 dalį su tomis 2 užklausomis, bet drąsiai tęskite ir pridėkite tiek „PokéAPI“ užklausų, kiek norite!

4 dalis: Pateikti POST užklausas su „Postman“, kad sakiniai būtų išversti į „Yoda“

Iki šiol teikėme tik GET užklausas, bet ką daryti, jei norėtume pateikti POST užklausą ten, kur mums reikia iš tikrųjų siųsti kai kuriuos duomenis?

Norėdami pateikti POST užklausą, naudosime „Yoda Translator“ API iš funtranslations.com. Nors ši API naudoja tik vieną parametrą, tai vis tiek yra geras viešasis taškas, kurį galime naudoti norėdami suprasti sąvoką.

Pirmiausia sukurkime naują kolekciją su nauja užklausa:

  • Kolekcija: įdomūs vertimai
  • Prašymas: Yoda

Šį kartą vietoj GET užklausos mūsų užklausų konfigūracija bus:

  • Užklausos tipas: POST
  • Užklausos URL: //api.funtranslations.com/translate/yoda

Dabar šį kartą, jei paspausime mėlyną mygtuką „ Siųsti “, pastebėsime, kad nesulauksime sėkmingo 200 atsakymo, gausime 400!

Mes iš tikrųjų niekada nenustatėme jokių duomenų, kurie būtų paskelbti API, ir tam reikalingi šie duomenys, todėl pridėkime juos.

Tiesiai po užklausos URL spustelėkite turinį . Tada vietoj nieko, kaip kėbulo tipą pasirinkite „ raw“ . Galiausiai, dešiniajame tipų dešinėje, pakeiskite tekstą į JSON .

Tada po juo esančioje vietoje galite pridėti:

{ "text": "Hello, I am learning how to test APIs with Postman!" } 

Dabar dar kartą spustelėkite mėlyną mygtuką „ Siųsti “ ir gausime sėkmingą atsakymą!

Šią koncepciją galime pritaikyti beveik bet kurioje API. „Postman“ neleidžia jums paskelbti tik JSON, bet ir naudoti kitus formatus, kuriuos matome išvardintuose „Body Type“ skyriuje, o tai reiškia, kad turite daug galimybių, priklausomai nuo to, ko reikalauja jūsų naudojama API.

5 dalis. Prašymų tikrinimas „Žiedų valdovo“ API su API raktu

Visą likusį apžvalgą naudosime „Žiedų valdovo“ API.

Pirmiausia „Žiedų valdovo“ API reikalauja autentifikavimo, kad galėtų pateikti užklausas naudodamas API raktą. Taigi, norėdami pradėti, turėsite, kol mes nersime, turėsite sukurti nemokamą paskyrą.

//the-one-api.herokuapp.com/sign-up

Kai užsiregistruosite ir prisijungsite, pirmiausia pamatysite savo API raktą! Arba nukopijuokite šį raktą žemyn, arba prisiminkite, kur galite jį rasti vėliau. Jei išeisite iš puslapio, visada galėsite jį patraukti, naršydami API svetainėje , eidami į „ Welcome“ ir tada „ Account “.

Norėdami pradėti, pirmiausia sukurkime naują kolekciją ir pateikime užklausą:

  • Kolekcija: Žiedų valdovas
  • Aplankas: filmas
  • Užklausa: visi filmai
  • Užklausos tipas: GET
  • Užklausos URL: //the-one-api.herokuapp.com/v1/movie

Kai atliksite pirmiau nurodytus veiksmus, spustelėkite Siųsti ir iškart pastebėsite, kad jis pateikia atsakymą, kuriame sakoma 401 ir kad jis nėra patvirtintas.

Kadangi šiai API reikalingas API raktas, būtent to ir tikėjomės. Taigi spustelėkite skirtuką Įgaliojimas . Tada mes galime pasirinkti tipasNešmenos token , o dešinėje, mes galime įklijuoti į mūsų raktas, kad mes tiesiog sukurti su Žiedų API Viešpaties.

Kai tik paspausime „ Siųsti“ , dabar matome sėkmingą atsakymą!

Tai pavyko išties puikiai, bet ką daryti, jei turime daugybę užklausų, kuriose naudojamas vienas raktas. Ar turime tai valdyti pagal kiekvieną prašymą?

Užuot tvarkę jį pagal kiekvieną atskirą užklausą, galime tvarkyti kolekcijoje. Pirmiausia sukurkime kitą prašymą.

„Žiedų valdovo“ kolekcijoje ir aplanke „Filmas“ sukurkite naują užklausą:

  • Užklausa: citata pagal filmo ID
  • Užklausos tipas: GET
  • Užklausos URL: //the-one-api.herokuapp.com/v1/movie/{id}

Šioje užklausoje naudokime pirmosios užklausos atsakymo 5cd95395de30eff6ebccde5bID, kurį naudosiu „The Two Towers“ ID, todėl užklausos URL atrodys taip:

//the-one-api.herokuapp.com/v1/movie/5cd95395de30eff6ebccde5b

Užuot nustatę savo prieigos raktą užklausos įgaliojime, mes paliksime tipą kaip paveldėti autentifikavimą iš tėvų . Spustelėkite tris taškus šalia kolekcijos ir pasirinkite Redaguoti .

Čia atliksime tą patį tikslą, ką darėme su pirmąja užklausa, bet rinkinio konfigūracijoje. Pasirinkite skirtuką „ Autorizacija “, po tipu pasirinkite „ Bearer Token“ ir „ Token“ lauke dar kartą įklijuokite savo prieigos raktą.

Galiausiai spustelėkite „ Atnaujinti“ ir dar kartą paspauskite mėlyną mygtuką „ Siųsti “ ir galime pamatyti sėkmingą užklausą!

Dabar galime grįžti į mūsų visų filmų užklausą ir atnaujinti įgaliojimą naudoti paveldėjimo tipo paveldėjimą iš tėvų, ir jis vis tiek turėtų veikti!

Ką dar galime padaryti su „Postman“?

Nors aš apžvelgiau daugybę pagrindų, su „Postman“ galite padaryti daug daugiau. Čia yra keletas mano mėgstamiausių.

aplinkos įvairovė

Jei dirbate kaip projekto kūrėjas, tikėtina, kad jūsų komanda naudoja kelias aplinkas, tokias kaip kūrimo ir gamybos aplinka. Užuot kūrę ir išlaikę visiškai atskiras užklausas, galite pridėti aplinkos kintamąjį ir pakeisti tą kintamąjį, kai perjungiate aplinką!

Kintamieji taikomi daugeliui scenarijų, tačiau tai įprasta. Peržiūrėkite „Postman“ dokumentus, kad sužinotumėte, kaip tai padaryti.

//learning.postman.com/docs/postman/variables-and-environments/variables/

Importuoti ir eksportuoti kolekcijas ir duomenis

Puikus „Postman“ dalykas yra tai, kad kai sutvarkysite visas savo užklausas, galėsite jas eksportuoti kitiems naudoti. Tai taip pat reiškia, kad galite importuoti kolekcijas iš kitų komandos narių. Tai leidžia daug lengviau įsitikinti, kad visi naudoja tą pačią kolekciją.

Premija: netgi galite saugoti šiuos failus „Git“ saugykloje, nes jie yra tik JSON.

Tačiau nepamirškite - jei kolekcijoje naudojate autorizaciją, kaip aprašėme šiame vadove, turėtumėte įsitikinti, kad eksportuodami kolekciją to neįtraukėte.

//learning.postman.com/docs/postman/collections/importing-and-exporting-data/

Automatizuotas testavimas

Kai kolekcijoje turite užklausų rinkinį ir dar geriau, jei jas saugote „Github“, galite pradėti naudoti šias užklausas kaip dalį automatizuoto API bandymo valdymo.

Nors tam yra keli sprendimai, „Postman“ įtraukia kolekcijos bėgiklį, įmontuotą tiesiai į programą, o „Newman“ yra komandinės eilutės įrankis, leidžiantis atlikti bandymus tiesiai iš terminalo.

//www.postman.com/use-cases/api-testing-automation/

Koks jūsų mėgstamiausias būdas išbandyti ir žaisti su API?

Pasidalink su manimi „Twitter“!

Sekite mane, norėdami sužinoti daugiau „Javascript“, „UX“ ir kitų įdomių dalykų!

  • ? Sekite mane „Twitter“
  • ? ️ Užsiprenumeruokite „My Youtube“
  • ✉️ Prisiregistruokite gauti mano naujienlaiškį