Postman Õpetus – kuidas kasutada API testimiseks?

Autor: Thomas Hamilton Thomas Hamilton
Hours Ajakohastatud

Mis on Postman?

Postman on skaleeritav API testimise tööriist, mis integreerub kiiresti CI/CD torujuhtmesse. See sai alguse 2012. aastal Abhinav Asthana kõrvalprojektina, et lihtsustada API töövoogu testimisel ja arendamisel. API tähistab rakenduste programmeerimisliidest, mis võimaldab tarkvararakendustel API-kõnede kaudu üksteisega suhelda.

Miks kasutada Postman?

Tänapäeval on üle 4 miljoni kasutaja Postman Tarkvarast on saanud valitud tööriist järgmistel põhjustel.

  1. Juurdepääsetavus – kasutamiseks Postman tööriist, tuleb lihtsalt oma kontodele sisse logida, mis muudab failidele juurdepääsu igal ajal ja igal pool, kuni Postman rakendus on arvutisse installitud.
  2. Kogude kasutamine – Postman võimaldab kasutajatel luua oma jaoks kogusid Postman API kõned. Iga kogu võib luua alamkaustu ja mitu päringut. See aitab teie testkomplekte korraldada.
  3. Koostöö – kogusid ja keskkondi saab importida või eksportida, muutes failide jagamise lihtsaks. Otselinki saab kasutada ka kogude jagamiseks.
  4. Keskkondade loomine – mitme keskkonna omamine aitab vähendada testide kordamist, kuna saab kasutada sama kogumit, kuid erineva keskkonna jaoks. Siin toimub parameetrite määramine, mida arutame järgmistes õppetundides.
  5. Testide loomine – igaühele saab lisada testi kontrollpunkte, näiteks HTTP-vastuse eduka oleku kontrollimist Postman API-kutsed, mis aitavad tagada testi katvus.
  6. Automatiseerimise testimine – Collection Runneri või Newmani abil saab teste käitada mitme iteratsioonina, säästes aega korduvate testide jaoks.
  7. Silumine – Postman konsool aitab kontrollida, milliseid andmeid on hangitud, muutes testide silumise lihtsaks.
  8. Pidev integreerimine – Tänu oma võimele toetada pidevat integratsiooni, säilitatakse arenduspraktikad.

Kuidas kasutada Postman API-de käivitamiseks

Allpool on Postman Tööruum. Uurime samm-sammult protsessi Kuidas kasutada Postman ja selle erinevad omadused Postman tööriist!

Kuidas kasutada Postman API-de käivitamiseks

  1. Uus – siin saate luua uue päringu, kogu või keskkonna.
  2. Import – seda kasutatakse kogu või keskkonna importimiseks. Saadaval on sellised valikud nagu import failist, kaustast, link või toorteksti kleepimine.
  3. Runner – automatiseerimisteste saab läbi viia Collection Runneri kaudu. Seda arutatakse pikemalt järgmises õppetükis.
  4. Ava uus – ava uus vaheleht, Postman Aken või Runner Window, klõpsates seda nuppu.
  5. Minu tööruum – saate luua uue tööruumi individuaalselt või meeskonnana.
  6. Kutsu – tehke tööruumis koostööd, kutsudes meeskonnaliikmeid.
  7. Ajalugu – teie saadetud minevikupäringud kuvatakse ajaloos. See muudab teie tehtud toimingute jälgimise lihtsaks.
  8. Kollektsioonid – korraldage oma testkomplekti, luues kogusid. Igal kogul võib olla alamkaustu ja mitu päringut. Taotlust või kausta saab ka dubleerida.
  9. Vahekaart Taotlus – see kuvab selle päringu pealkirja, millega töötate. Vaikimisi kuvatakse pealkirjadeta taotluste puhul „Pealkirjata taotlus”.
  10. HTTP-päring – sellel klõpsates kuvatakse rippmenüü erinevatest taotlustest, nagu GET, POST, COPY, DELETE jne. Postman API testimine, kõige sagedamini kasutatavad päringud on GET ja POST.
  11. Taotluse URL – tuntud ka kui lõpp-punkt, see on koht, kus saate tuvastada lingi, millega API suhtleb.
  12. Salvesta – kui taotluses on muudatusi, tuleb klõpsata Salvesta, et uued muudatused kaotsi ei läheks ega üle ei kirjutataks.
  13. Parameetrid – siia saate kirjutada päringu jaoks vajalikud parameetrid, näiteks võtmeväärtused.
  14. Autoriseerimine – API-dele juurdepääsuks on vaja nõuetekohast autoriseerimist. See võib olla kasutajanime ja parooli, kandja märgi vms kujul.
  15. Päised – olenevalt organisatsiooni vajadustest saate määrata päised, näiteks sisutüübi JSON.
  16. Keha – see on koht, kus saab kohandada POST-päringus tavaliselt kasutatava päringu üksikasju.
  17. Eelpäringu skript – need on skriptid, mis käivitatakse enne päringut. Tavaliselt kasutatakse seadistuskeskkonna eelpäringu skripte, et tagada testide käitamine õiges keskkonnas.
  18. Testid – need on päringu ajal käivitatavad skriptid. Testide olemasolu on oluline, kuna see loob kontrollpunktid, et kontrollida, kas vastuse olek on korras, hangitud andmed on ootuspärased, ja muud testid.

GET Requestsiga töötamine

Hankimistaotlusi kasutatakse teabe hankimiseks antud URL-ilt. Lõpp-punktis muudatusi ei tehta.

Kasutame kõigi selle näidete jaoks järgmist URL-i Postman juhendaja https://jsonplaceholder.typicode.com/users

Tööruumis

  1. Määrake oma HTTP-päringuks GET.
  2. Sisestage päringu URL-i väljale link
  3. Klõpsake nuppu Saada
  4. Näete teadet 200 OK
  5. Kehas peaks olema 10 kasutaja tulemust, mis näitavad, et teie test on edukalt läbitud.

Töötage rakendusega Get Requests

* Märkus: Võib esineda juhtumeid, kus Get Postman taotlus võib ebaõnnestuda. Põhjuseks võib olla kehtetu päringu URL või vaja on autentimist.

SEOTUD ARTIKLID

POST-i taotlustega töötamine

Postituspäringud erinevad Hangi päringust, kuna kasutaja lisab lõpp-punkti andmeid andmetega. Kasutades samu andmeid eelmisest õpetusest rakenduses Hangi päring, lisame nüüd oma kasutaja.

Step 1) Uue taotluse loomiseks klõpsake uut vahekaarti.

Postitustaotlustega töötamine

Step 2) Uuel vahelehel

  1. Määrake oma HTTP-päringuks POST.
  2. Sisestage sama link päringu URL-i: https://jsonplaceholder.typicode.com/users
  3. lülituge vahekaardile Keha

Postitustaotlustega töötamine

Step 3) Kehas,

  1. Klõpsake toores
  2. Valige JSON

Postitustaotlustega töötamine

Step 4) Kopeerige ja kleepige ainult üks kasutaja tulemus eelmisest hankimistaotlusest, nagu allpool. Veenduge, et kood oleks õigesti kopeeritud, kasutades selleks seotud lokkis sulgusid ja sulgusid. Muutke id väärtuseks 11 ja nimi mis tahes soovitud nimeks. Saate muuta ka muid üksikasju, näiteks aadressi.

[
    {
        "id": 11,
        "name": "Krishna Rungta",
        "username": "Bret",
        "email": "[email protected]",
        "address": {
            "street": "Kulas Light",
            "suite": "Apt. 556",
            "city": "Gwenborough",
            "zipcode": "92998-3874",
            "geo": {
                "lat": "-37.3159",
                "lng": "81.1496"
            }
        },
        "phone": "1-770-736-8031 x56442",
        "website": "hildegard.org",
        "company": {
            "name": "Romaguera-Crona",
            "catchPhrase": "Multi-layered client-server neural-net",
            "bs": "harness real-time e-markets"
        }
    }
]

Postitustaotlustega töötamine

* Märkus: Veebipostituse päring peaks olema õiges vormingus, et tagada nõutud andmete loomine. Päringu JSON-vormingu kontrollimiseks on hea tava kasutada funktsiooni Get first. Võite kasutada selliseid tööriistu nagu https://jsonformatter.curiousconcept.com/

Postitustaotlustega töötamine

Step 5) Järgmine,

  1. Klõpsake nuppu Saada.
  2. Olek: 201 Loodud tuleks kuvada
  3. Postitatud andmed kuvatakse kehas.

Postitustaotlustega töötamine

Kuidas taotlusi parameetristada

Andmete parameetrite määramine on üks kõige kasulikumaid funktsioone Postman. Selle asemel, et luua samu päringuid erinevate andmetega, saate kasutada parameetritega muutujaid. Need andmed võivad pärineda andmefailist või keskkonnamuutujast. Parameetristamine aitab vältida samade testide kordamist ja iteratsioone saab kasutada automaatika testimine.

Parameetrid luuakse topeltsulgude abil: {{sample}}. Vaatame näidet parameetrite kasutamisest meie eelmises taotluses:

Taotluste parameetrid

Nüüd loome parameetrite hankimise taotluse.

Step 1)

  1. Määrake oma HTTP-päringuks GET
  2. Sisestage see link: https://jsonplaceholder.typicode.com/users. Asendage lingi esimene osa parameetriga, näiteks {{url}}. Taotluse URL peaks nüüd olema {{url}}/users.
  3. Klõpsake saada.

Vastust ei tohiks tulla, kuna me pole oma parameetri allikat määranud.

Taotluste parameetrid

Step 2) Parameetri kasutamiseks peate määrama keskkonna

  1. Klõpsake silmaikoonil
  2. Muutuja määramiseks globaalsele keskkonnale, mida saab kasutada kõigis kogudes, klõpsake nuppu Redigeeri.

Taotluste parameetrid

Step 3) muutuvas,

  1. määrake nimeks URL, mis on https://jsonplaceholder.typicode.com
  2. klõpsake nuppu Salvesta.

Taotluste parameetrid

Step 4) Kui näete järgmist ekraani, klõpsake nuppu Sule

Taotluste parameetrid

Step 5) Minge tagasi oma hankimistaotluse juurde ja klõpsake siis nuppu Saada. Nüüd peaksid teie taotlusele tulemused olema.

Taotluste parameetrid

* Märkus: Vigade vältimiseks veenduge alati, et teie parameetritel oleks allikas, näiteks keskkonnamuutuja või andmefail.

Kuidas luua Postman Testid

Postman Testid on JavaPäringutele lisatud skriptikoodid, mis aitavad teil kontrollida tulemusi (nt edukas või ebaõnnestunud olek, oodatavate tulemuste võrdlus jne). Tavaliselt algab see pm.testiga. Seda saab võrrelda väidetega, kontrollige käske, mis on saadaval muudes tööriistades.

Teeme mõned põhilised API testimine kasutamine Postman meie eelmise õppetunni parameetrite määramise taotluste jaoks.

Step 1) Minge eelmises õpetuses oma GET-i kasutajataotlusele.

  1. Lülituge vahekaardile Testid. Paremal küljel on koodilõigud.
  2. Klõpsake jaotises Väljavõtted valikul "Olukood: kood on 200".

Paan täidetakse automaatselt

Looma Postman Testid

Step 2) Nüüd klõpsake nuppu Saada. Nüüd tuleks kuvada testi tulemus.

Looma Postman Testid

Step 3) Minge tagasi vahekaardile Test ja lisame veel ühe testi. Seekord võrdleme oodatud tulemust tegeliku tulemusega.

Klõpsake jaotises Koopiad valikul „Response body:JSON value check”. Kontrollime, kas Leanne Grahamil on kasutajatunnus 1.

Looma Postman Testid

Step 4)

  1. Asendage koodis "Teie testinimi" tekstiga "Kontrollige, kas id1-ga kasutaja on Leanne Graham", nii et testi nimi täpsustaks täpselt, mida me testida tahame.
  2. Asendage jsonData.value väärtusega jsonData[0].name. Tee hankimiseks kontrollige keha jaotises Hangi tulemus varem. Kuna Leanne Graham on kasutajatunnus 1, on jsonData esimeses tulemuses, mis peaks algama 0-ga. Kui soovite saada teist tulemust, kasutage järgmiste tulemuste saamiseks jsonData[1] ja nii edasi.
  3. Eql-i sisestage "Leanne Graham"
pm.test("Check if user with id1 is Leanne Graham", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData[0].name).to.eql("Leanne Graham");
});

Looma Postman Testid

Step 5) Klõpsake saada. Nüüd peaks teie taotluse jaoks olema kaks läbitud testi tulemust.

Looma Postman Testid

* Märkus: Seal saab luua erinevat tüüpi teste Postman. Proovige tööriista uurida ja vaadake, millised testid teie vajadustele vastavad.

Kuidas luua kollektsioone

Kollektsioonidel on testkomplektide korraldamisel oluline roll. Seda saab importida ja eksportida, mis muudab kollektsioonide jagamise meeskonna vahel lihtsaks. Selles õpetuses õpime, kuidas kollektsiooni luua ja teostada.

Alustame kollektsiooni loomisega:

Step 1) Klõpsake lehe vasakus ülanurgas nuppu Uus.

Loo kogud

Step 2) Valige Kogu. Ilmuma peaks kogu loomise aken.

Loo kogud

Step 3) Sisestage soovitud kogu nimi ja kirjeldus, seejärel klõpsake nuppu Loo. Nüüd tuleks luua kollektsioon.

Loo kogud

Step 4) Mine tagasi eelmise Hankimistaotluse juurde. Klõpsake nuppu Salvesta

Loo kogud

Step 5)

  1. valima Postman Testikogu.
  2. Klõpsake nuppu Salvesta Postman Testikogu

Loo kogud

Step 6) Postman testikogu peaks nüüd sisaldama ühte päringut.

Loo kogud

Step 7) Korrake samme 4–5 eelmise postitamispäringu jaoks, et kogumisel oleks nüüd kaks päringut.

Loo kogud

Kogude käivitamine Collection Runneri abil

Kogu käitamiseks on kaks võimalust: Collection Runner ja Newman. Alustame kollektsiooni käivitamisega Collection Runneris.

Step 1) Klõpsake nupul Runner, mis asub lehe ülaosas nupu Impordi kõrval.

Käivitage kogusid Collection Runneri abil

Step 2) Collection Runneri leht peaks ilmuma nagu allpool. Järgnevalt kirjeldatakse erinevaid valdkondi

Käivitage kogusid Collection Runneri abil

Step 3) Käivita oma Postman Testikogu, seadistades järgmise:

  • Vali Postman testikogu – määrake iteratsioonideks 3
  • Määra viivituseks 2500 ms
  • Klõpsake nuppu Käivita Postman Test… nupp

Käivitage kogusid Collection Runneri abil

Step 4) Pärast nupu Käivita klõpsamist tuleks kuvada leht Käivita tulemused. Sõltuvalt viivitusest peaksite nägema teste nende täitmise ajal.

  1. Kui testid on lõppenud, näete testi olekut, kas see on läbitud või ebaõnnestunud, ja tulemusi iga iteratsiooni kohta.
  2. Saate taotluste hankimise jaoks kuvada passi olek
  3. Kuna meil polnud Posti jaoks teste, peaks tulema teade, et päringul ei olnud teste.

Käivitage kogusid Collection Runneri abil

Näete, kui oluline on, et teie päringutes on testid, et saaksite kontrollida HTTP-päringu olekut, kui see õnnestub ja andmed luuakse või tuuakse.

Kuidas kogusid Newmani abil käivitada

Teine viis kollektsiooni haldamiseks on Newmani kaudu. Peamised erinevused Newmani ja Collection Runneri vahel on järgmised:

  1. Newman on lisandmoodul Postman. Peate selle omarakendusest eraldi installima.
  2. Newman kasutab käsurida, samas kui Collection Runneril on GUI.
  3. Newmani saab kasutada pidevaks integreerimiseks.

Newmani installimiseks ja meie kollektsiooni käivitamiseks tehke järgmist.

Step 1) Installige nodejs selle lingi abil: http://nodejs.org/download/

Step 2) Avage käsurida ja sisestage

 npm install -g newman

Newman peaks nüüd olema teie arvutisse installitud.

Käivitage kogud Newmani abil

Step 3) Kui Newman on installitud, pöördume tagasi meie juurde Postman Klõpsake väljal Kogud kolmel punktil. Valikud peaksid nüüd ilmuma. Valige Ekspordi.

Käivitage kogud Newmani abil

Step 4) Valige Ekspordi kogu koguks v2.1 (soovitatav) ja seejärel klõpsake nuppu Ekspordi.

Käivitage kogud Newmani abil

Step 5) Valige soovitud asukoht ja klõpsake siis nuppu Salvesta. Soovitav on luua oma jaoks konkreetne kaust Postman testid. Kogu tuleks nüüd eksportida teie valitud kohalikku kataloogi.

Step 6) Peame ka oma keskkonda eksportima. Klõpsake globaalses keskkonna rippmenüü kõrval olevat silmaikooni ja valige Laadi alla JSON-ina. Valige soovitud asukoht ja klõpsake siis nuppu Salvesta. Soovitav on, et keskkond asuks teie koguga samas kaustas.

Käivitage kogud Newmani abil

Step 7) Keskkond tuleks nüüd eksportida samasse kohalikku kataloogi, kuhu kogumine.

Step 8) Nüüd minge tagasi käsureale ja muutke kataloog sinna, kuhu olete kogu ja keskkonna salvestanud.

 cd C:\Users\Asus\Desktop\Postman Tutorial

Step 9) Käivitage oma kollektsioon selle käsuga:

 newman run PostmanTestCollection.postman_collection.json -e Testing.postman_globals.json

Käivitamise tulemused peaksid nüüd ilmuma nagu allpool.

Käivitage kogud Newmani abil

Juhendis on viide mõnele Newmani põhikoodile täitmiseks:

  1. Käitage ainult kogu. Seda saab kasutada, kui puudub keskkonna- või testandmete failisõltuvus.
    2. newman run <collection name>
  2. Käivitage kogu ja keskkond. -e indikaator on keskkonna jaoks.
    3. newman run <collection name> -e <environment name>
  3. Käivitage kogu soovitud numbriga. iteratsioonidest.
    4. newman run <collection name> -n <no.of iterations>
  4. Käivitage andmefailiga. 
    5. newman run <collection name> --data <file name>  -n <no.of iterations> -e <environment name>
  5. Määra viivitusaeg. See on oluline, kuna testid võivad ebaõnnestuda, kui seda käivitatakse viivitamatult, kuna päringuid alustatakse ilma, et eelmine päring oleks lõpp-punkti serveris töötlemise lõpetanud.
newman run <collection name> -d <delay time>

Meie Postman intervjuu küsimuste juhend aitab teil intervjuu läbi murda ja aitab teil saada unistuste töökoha tarkvara testimiseks.

kokkuvõte

  • API testimine kasutades Postman: Postman on rakendus API-de testimiseks. Postman on üks populaarsemaid tööriistu, mida kasutatakse API testimisel, mis saadab päringuid veebiserverisse ja saab vastuse tagasi
  • Juurdepääsetavus, kogude kasutamine, koostöö, pidev integreerimine on mõned põhifunktsioonid, mida õppida. Postman
  • Soovitatav on luua konto Postman, nii et teie kollektsioonid on veebis saadaval
  • Saate parameetrid sisse lülitada Postman
  • Postimehe taotluse kinnitamiseks saate luua teste
  • Kogusid saab käitada Newmani või Collection Runneri abil

Teile võib meeldida: