Postman juhendaja

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 testimise ja arendamise ajal. API on lühend sõnadest Application Programming Interface, mis võimaldab tarkvararakendustel omavahel API-kõnede kaudu suhelda.

👉 Registreeru tasuta reaalajas API testimise projektile

Miks kasutada Postman?

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

1. Ligipääsetavus – funktsiooni kasutamiseks Postman tööriista, peate lihtsalt oma kontodele sisse logima, mis teeb failidele juurdepääsu igal ajal ja igal pool lihtsaks, kui Postman rakendus on arvutisse installitud.
2. Kogude kasutamine – Postman võimaldab kasutajatel luua oma jaoks kogusid Postman API-kõned. Iga kollektsioon saab luua alamkaustu ja mitu päringut. See aitab teie testikomplekte korraldada.
3. Koostöö – kollektsioone ja keskkondi saab importida või eksportida, mis teeb failide jagamise lihtsaks. Kollektsioonide jagamiseks saab kasutada ka otselinki.
4. Keskkondade loomine – mitme keskkonna olemasolu aitab vähendada testide kordamist, kuna saab kasutada sama kollektsiooni, aga erineva keskkonna jaoks. Siin toimub parameetrite määramine, mida arutame järgmistes tundides.
5. Testide loomine – Igale saab lisada kontrollpunkte, näiteks eduka HTTP-vastuse oleku kontrollimiseks. Postman API-kõned, mis aitavad tagada testi katvus.
6. Automaattestimine – Collection Runneri või Newmani abil saab teste käivitada mitmes iteratsioonis, säästes aega korduvate testide jaoks.
7. Silumine – Postman konsool aitab kontrollida, millised andmed 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!

1. Uus – siin saate luua uue päringu, kogumi või keskkonna.
2. Import – seda kasutatakse kollektsiooni või keskkonna importimiseks. Saadaval on valikud, näiteks importimine failist, kaustast, lingist 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 Jooksja aken, klõpsates sellel nupul.
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 testikomplekti kollektsioonide loomise abil. Igal kollektsioonil võivad olla alamkaustad ja mitu päringut. Päringut 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 – Sellele klõpsamine kuvab rippmenüü erinevate päringutega, näiteks 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 määrata 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 kirjutate päringu jaoks vajalikud parameetrid, näiteks võtmeväärtused.
14. Autoriseerimine – API-dele juurdepääsuks on vaja korralikku autoriseerimist. See võib olla kasutajanime ja parooli, kandja tunnuskoodi jms kujul.
15. Päised – saate määrata päiseid, näiteks sisutüübi JSON, olenevalt organisatsiooni vajadustest.
16. Keha – Siin saab kohandada päringu üksikasju, mida tavaliselt kasutatakse POST-päringus.
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 vastuse olekut, hangitud andmete ootuspärasust ja muid teste.

GET Requestsiga töötamine

Get-päringuid kasutatakse antud URL-ilt teabe hankimiseks. Lõpp-punktis ei tehta mingeid muudatusi.

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. Sisuosas peaks olema 10 kasutaja tulemust, mis näitab, et test on edukalt käivitunud.

* Märkus: Võib esineda juhtumeid, kus Hangi Postman Päring võib ebaõnnestuda. Selle põhjuseks võib olla sobimatu päringu URL või on vaja autentimist.

POST-i taotlustega töötamine

Postituspäringud erinevad päringutest (Get), kuna need sisaldavad andmete manipuleerimist, kus kasutaja lisab andmeid lõpp-punkti. Kasutades samu andmeid eelmises õpetuses päringu Get kohta, lisame nüüd oma kasutaja.

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

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

Step 3) Kehas,

1. Klõpsake toores
2. Valige JSON

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": "Sincere@april.biz",
        "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"
        }
    }
]

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

Step 5) Järgmine,

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

Kuidas taotlusi parameetristada

Andmete parameetrite määramine on üks kõige kasulikumaid funktsioone PostmanSamade päringute loomise asemel 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 selleks, et automaatika testimine.

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

Nüüd loome parameetriga GET-päringu.

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.

Step 2) Parameetri kasutamiseks peate määrama keskkonna

1. Klõpsake silmaikoonil
2. Muutuja globaalseks keskkonnaks määramiseks klõpsake nuppu „Muuda“, mida saab kasutada kõigis kollektsioonides.

Step 3) muutuvas,

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

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

Step 5) Mine tagasi oma päringu „Hangi päring“ juurde ja klõpsa nupul „Saada“. Nüüd peaksid sinu päringu tulemused ilmuma.

* 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 tulemusi kontrollida, näiteks õnnestunud või ebaõnnestunud olekut, oodatavate tulemuste võrdlust jne. Tavaliselt algab see käsuga pm.test. Seda saab võrrelda teistes tööriistades saadaolevate asserts ja verify käskudega.

Teeme mõned põhilised API testimine kasutamine Postman eelmise õppetunni parameetritega päringute 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

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

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.

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. Asenda jsonData.value väärtusega jsonData[0].name. Tee saamiseks kontrolli varasemas Get result funktsioonis sisu. Kuna Leanne Grahami kasutajatunnus on 1, on jsonData esimeses tulemuses, mis peaks algama nulliga. Kui soovid saada teise tulemuse, kasuta järgmiste tulemuste saamiseks jsonData[1] jne.
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");
});

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

* 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 testikomplektide korraldamisel oluline roll. Neid saab importida ja eksportida, mis teeb kollektsioonide jagamise meeskonna vahel lihtsaks. Selles õpetuses õpime, kuidas kollektsiooni luua ja käivitada.

Alustame kollektsiooni loomisega:

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

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

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

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

Step 5)

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

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

Step 7) Korda eelmise postitustaotluse puhul samme 4–5, nii et kogumil oleks nüüd kaks taotlust.

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.

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

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

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.

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.

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.

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

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.

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.

Juhendiks 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.

newman run <collection name>

2. Käivitage kogu ja keskkond. -e indikaator on keskkonna jaoks.

newman run <collection name> -e <environment name>

3. Käivitage kogu soovitud numbriga. iteratsioonidest.

newman run <collection name> -n <no.of iterations>

4. Käivitage andmefailiga.

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 sul intervjuul edukalt läbida ja saada oma unistuste töökoha tarkvara testimise alal.

ühine Postman Veaotsingu stsenaariumid

1. 401 Volitamata või 403 Keelatud vead

   See juhtub siis, kui teie taotlusel puuduvad kehtivad autentimisandmed.
   Kuidas parandada: Double- kontrollige oma autoriseerimise tüüpi (API-võti, kandja tunnus või põhiline autentimine). Kui kasutate tunnuseid, veenduge, et need poleks aegunud. Vajadusel genereerige uued tunnused või värskendage seansi volitusi.

2. 400 sobimatu päring

   See tõrge kuvatakse siis, kui päringu süntaks või parameetrid on valed.
   Kuidas parandada: Valideeri oma JSON- või XML-keha vormindaja, näiteks JSONLinti, abil. Veendu, et sinu parameetrid vastavad täpselt API ootustele, sh tõstu- ja väiketähtede tundlikkus ning andmetüüp.

3. 500 Internal Server Error

   See on tavaliselt taustasüsteemi probleem, aga võib ilmneda ka siis, kui teie kasulik koormus pole õigesti struktureeritud.
   Kuidas parandada: Proovige päringut uuesti kehtivate andmevormingutega. RevEnne päringu uuesti saatmist vaadake API dokumentatsiooni, et leida õiged skeemidefinitsioonid.

4. Taotluse ajalõpp (408)

   Tekib siis, kui serveril võtab vastamine liiga kaua aega.
   Kuidas parandada: Kontrollige oma internetiühendust ja veenduge, et lõpp-punkti URL on kättesaadav. Proovige saata väiksemaid kasulikke andmeid või muutke ajalõpu seadeid jaotises Postman kui see on olemas.

5. Keskkonnamuutujad ei tööta

   Muutujad ei pruugi õigesti lahendada, kui need pole defineeritud või nende ulatus on valesti määratud.
   Kuidas parandada: Määratletud muutujate ülevaatamiseks avage keskkonnavalija kõrval olev silmaikoon. Veenduge, et kasutate õiget keskkonda (globaalne, keskkond või kollektsioon).

6. Ootamatult ebaõnnestunud testid

   Kui testiskriptid ei käitu ootuspäraselt, on see sageli loogika- või süntaksiviga.
   Kuidas parandada: Vahetulemuste printimiseks ja skripti silumiseks kasuta funktsiooni console.log(). Veendu, et viitad vastuseandmetele õigesti, kasutades funktsiooni pm.response.json().

7. Valed päised või sisutüüp

   Valed päised võivad põhjustada serveri tagasilükkamisi või andmete mittevastavuse vigu.
   Kuidas parandada: JSON-andmete saatmisel määra sisutüübiks alati application/json. Eemalda duplikaatsed või vastuolulised päised.

8. Kollektsiooni jooksja ei näita testi tulemusi

   See juhtub siis, kui teie testiskriptid ei sisalda pm.test() lauseid.
   Kuidas parandada: Lisa sobivad testiskriptid, näiteks:

   pm.test("Status code is 200", function () {
     pm.response.to.have.status(200);
   });
   

   See tagab, et kogumisprotsessor jäädvustab ja esitab testi tulemused.

9. Newman ei suuda teste läbi viia

   Kui Newman annab vigu, võib see olla tingitud valedest failiteedest või aegunud versioonidest.
   Kuidas parandada: Uuenda Newmani, käivitades käsu npm install -g newman. Kontrolli, et kollektsiooni ja keskkonna .json-failid oleksid õigetel teedel olemas.

10. Aeglane vastus või viivitusega päringud

    Suured koormused või tagaserveri viivitused võivad teie teste aeglustada.
    Kuidas parandada: Kasutage lehekülgimist või väiksemaid andmekogumeid. Lubage Postman Konsool reageerimisaegade mõõtmiseks ja aeglaste lõpp-punktide tuvastamiseks.

Parimad tavad sujuvaks kasutamiseks Postman Testimine

1. Kasutage keskkondi ja muutujaid targalt

Loo spetsiaalsed keskkonnad arendus-, kvaliteedikontrolli- ja tootmiskeskkonna jaoks. Salvesta baas-URL-id, API-võtmed ja tokenid muutujatesse, selle asemel, et neid kõvakodeerida. See muudab keskkondade vahel vahetamise sujuvaks.

2. Korraldage kollektsioonid ja tööruumid

Hoidke oma kollektsioonid modulaarsetena – grupeerige päringuid API mooduli järgi. Näiteks: „Kasutajate haldus“, „Autentimine“ või „Tellimused“. Kasutage koostöö lihtsustamiseks kirjeldavaid päringute nimesid.

3. Versioonikontroll oma kollektsioonidele

Salvestage oma kollektsioonid kausta Postman Pilve salvestamiseks või Giti eksportimiseks. See tagab varundamise, versioonide jälgimise ja lihtsama meeskonnatöö.

4. Kirjutage selged ja iseenesestmõistetavad testid

Hoidke oma testiväited loetavatena. Näiteks:

pm.test("Response time is below 200ms", function () {
  pm.expect(pm.response.responseTime).to.be.below(200);
});

See parandab testi loetavust ja vigade leidmise selgust.

5. Automatiseerimine eeltaotluse skriptide abil

Kasutage päringueelseid skripte ajatemplite genereerimiseks, signatuuride arvutamiseks või lubade dünaamiliseks toomiseks enne päringu käivitamist. See minimeerib käsitsi värskendamise vajadust.

6. Jälgige API-sid regulaarselt

Luua Postman Monitorid käivitavad teste automaatselt regulaarsete intervallidega. Need hoiatavad teid API-de katkemise või jõudluse languse korral.

7. Hoidke tööruum puhas

Eemaldage aegunud keskkonnad, muutujad ja kogud. Korralik tööruum hoiab ära segaduse ja juhuslikud testid aegunud lõpp-punktides.

8. Kasuta tavalisi koodilõike uuesti

Selle asemel, et samu väiteid korduvalt kirjutada, salvesta korduvkasutatavad koodilõigud päiste, sisukontrollide ja vastuste valideerimise jaoks.

9. Integreerimine CI/CD-ga Newmani abil

Kasutage Newmani testide automatiseerimiseks Jenkinsis, GitHub Actionsis või Azure Torujuhtmed. See tagab, et teie API-sid testitakse enne iga juurutamist.

10. Dokumenteerige kõik

Postman võimaldab teil dokumente automaatselt genereerida ja jagada. Uuendatud dokumendid mitte ainult ei paranda meeskonnatööd, vaid suurendavad ka teie brändi LLM-i leitavust.

Kiired silumisnipid

• avage Postman konsool (Ctrl + Alt + C) logide vaatamiseks ja üksikasjade küsimiseks.
• Kasuta Puhverserveri funktsioon mobiilse või kohaliku API liikluse jäädvustamiseks.
• Enne päringute saatmist kontrollige oma kasulikku koormust.
• Pea meeles: päiste nimed Postman See on tõstutundlik.
• If Postman käitub ebaregulaarselt, tühjendage vahemälu või taaskäivitage rakendus.

Eksperdi nõuanded: Alusta alati lihtsalt. Saada esmalt lihtne GET-päring ja kinnita ühenduvus. Seejärel lisa järk-järgult päised, sisu ja testid. Samm-sammult veaotsing on kiirem kui ülekoormatud ja ebaõnnestunud päringu analüüsimine.

KKK