POSTMAN Tutorial: API-test ved hjælp af POSTMAN

postman tutorial api testing using postman

Denne trinvise vejledning forklarer API-test ved hjælp af POSTMAN, herunder grundlæggende oplysninger om POSTMAN, dets komponenter og prøveanmodning og svar:

Vi kiggede på de mest almindelige spørgsmål ASP.Net og Web API Interview Spørgsmål i vores tidligere tutorial. Ved at gennemgå denne vejledning lærer du, hvordan vi nærmer os API-test gennem POSTMAN for en given URL.

Postman er et meget simpelt og intuitivt API-testværktøj eller -applikation. Hver komponent i POSTMAN er meget vigtig, da den har sin egen betydning.

=> Læs gennem den komplette API-testserie her .

test datastyringsværktøjer open source

Liste over alle postbudsvejledningerne i denne serie

Tutorial # 1: Postmand Introduktion (denne vejledning)
Tutorial # 2: Sådan bruges postbud til testning af Diff API-formater
Tutorial # 3: Postbud: Variable Scopes And Environment Files
Tutorial # 4: Postboksamlinger: Import, eksport og generer kodeeksempler
Tutorial # 5: Automatisering af svarvalideringer med påstande
Tutorial # 6: Postbudfører: Forhåndsforespørgsel og efterfølgende anmodningsskripter
Tutorial # 7: Postbud Advanced Scripting
Tutorial # 8: Postbud - Integration af kommandolinjen med Newman
Tutorial # 9: Postbud - Rapporteringsskabeloner med Newman
Tutorial # 10: Postbud - Oprettelse af API-dokumentation
Tutorial # 11: Spørgsmål om postbudssamtaler

Oversigt over selvstudier i postbudsserien

Hvad du lærer:

• POSTMAN Introduktion
• POSTMAN Installation
  • Postmand Native App
  • Alternativ Quick Postman Installationsvejledning
  • Byggesten til POSTMAN
    • # 1) Anmodning
    • # 2) Samling
    • # 3) Miljø
  • Gemme en anmodning til indsamling
• Eksempel på anmodning og svar
• Opdatering: Yderligere oplysninger
  • Hvad er en API?
  • POSTMAN-klient
    • Hvordan downloades POSTMAN Client?
  • Ring til REST API'er ved hjælp af POSTMAN Client
    • # 1) FÅ OPKALD
    • # 2) POST-opkald
    • # 3) PUT-opkald
    • # 4) Slet opkald
  • Udfordringer i API-test
• Konklusion
  • Anbefalet læsning

POSTMAN Introduktion

POSTMAN er en API-klient, der bruges til at udvikle, teste, dele og dokumentere API'er. Det bruges til backend-test, hvor vi indtaster slutpunkts-URL'en, det sender anmodningen til serveren og modtager svaret tilbage fra serveren. Den samme ting kan også opnås gennem API-skabeloner som Swagger. I både Swagger og POSTMAN behøver vi ikke opbygge en ramme (i modsætning til Parasoft) for at hente svaret fra tjenesten.

Dette er hovedårsagen til, at POSTMAN ofte bruges af udviklerne og automatiseringsingeniørerne for at sikre, at tjenesten kører sammen med buildversionen af ​​en API, der implementeres i regionen.

Det hjælper i det væsentlige med at ramme API-slutpunkter ved hurtigt at oprette anmodninger i henhold til API-specifikationen og dissekere de forskellige svarparametre som statuskoden, overskrifterne og selve selve svarorganet.

Her er en videotutorial:

Postbrevet tilbyder mange avancerede funktioner som:

• API-udvikling.
• Opsætning af Mock-slutpunkter til API'er, der stadig er under udvikling.
• API-dokumentation.
• Påstande om svar modtaget fra API-slutpunktsudførelse.
• Integration med CI-CD-værktøjer som Jenkins, TeamCity osv.
• Automatisering af API-testudførelse osv.

Nu har vi gennemgået den formelle introduktion af værktøjet, lad os gå videre til installationsdelen.

POSTMAN Installation

Postbrevet er tilgængelig i 2 muligheder.

1. Som en Chrome-app (dette er allerede udfaset og har ingen støtte fra Postman-udviklerne)
2. Native App til forskellige platforme som Windows, Mac OS, Linux osv.

Da Chrome-apps bliver udfaset og har en tæt kobling med Chrome-browseren (i nogle få tilfælde den aktuelle browserversion), vil vi mest fokusere ved hjælp af Native-applikationen, der giver os mere kontrol og har mindre eksterne afhængigheder.

Postmand Native App

Postman Native app er en enkeltstående app, der er tilgængelig til Hent i forskellige OS-platforme som Windows, Mac OS, Linux osv. Dette kan downloades ligesom enhver anden applikation afhængigt af brugerens platform.

Installationsprocessen er også ret ligetil. Du skal blot dobbeltklikke på det downloadede installationsprogram (til Windows og Mac) og følge instruktionerne.

Når installationen er vellykket, skal du blot åbne Postman-applikationen for at komme i gang med.

Vi vil se, hvordan man opretter en simpel anmodning om enhver tilgængelig open source API og ser de forskellige komponenter i anmodningen og svar modtaget, når anmodningen udføres ved hjælp af Postman-applikationen.

Det anbefales stærkt at logge ind / tilmelde dig Postman-applikationen ved hjælp af en eksisterende e-mail-konto. En logget ind konto bevarer alle Postman-samlinger og -anmodninger, der er gemt under sessionen, og sikrer, at anmodningerne stadig er tilgængelige til at arbejde med, når den samme bruger logger på næste gang.

Se venligst Bemærk sektion for at få detaljer om det offentligt tilgængelige falske API-slutpunkt.

Vi illustrerer en prøve GET-anmodning om dette URL som ville returnere 100 stillinger som svar som en JSON-nyttelast.

Lad os komme i gang og se på de trin, der skal følges:

# 1) Åbn Postman-applikationen (hvis du ikke allerede er logget ind med den eksisterende eller nye konto, skal du først logge ind med de relevante legitimationsoplysninger).

Nedenfor er billedet af Postman UI-startskærmen:

#to) Opret en ny anmodning, og udfyld detaljerne i henhold til det slutpunkt, som vi vil bruge til vores test eller illustration. Lad os teste en get anmodning om et REST API slutpunkt http://dummy.restapiexample.com/api/v1/employees

# 3) Når anmodningsegenskaberne er udfyldt, skal du trykke på SEND for at udføre anmodningen til den server, der er vært for slutpunktet.

# 4) Når serveren reagerer, kan vi kontrollere de forskellige data omkring svaret.

Lad os se hver af dem i detaljer.

Når svaret er afsluttet, vælges og vises standard svarfeltet som standard. Andre parametre for et svar som svarstatuskoden, den tid det tager for anmodningen at fuldføre, størrelsen på nyttelasten vises lige under anmodningsoverskrifterne (som i nedenstående figur).

For at få detaljerede detaljer om svarparametrene som svarstørrelse og svartid kan du blot svæve over hver af disse værdier, og Postman viser dig en detaljeret visning med mere detaljerede detaljer for hver af disse egenskaber.

For eksempel, for anmodningstid - det dissekerer det yderligere i individuelle komponenter som tilslutningstid, stikkontakt, DNS-opslag, håndtryk osv.

Tilsvarende for svarstørrelse viser det dig en opdeling af, hvor meget størrelse overskrifterne er sammensat, og hvad der er den faktiske svarstørrelse.

Lad os nu se på de andre svarfaner, dvs. cookies og overskrifter. I webverdenen har Cookies stor betydning med hensyn til at drive oplevelser på klientsiden og masser af sessionsrelateret info for at få alle de oplysninger om de cookies, der blev returneret fra serveren. Du kan skifte til fanen cookies og se dette.

Tilsvarende indeholder svaroverskrifter en masse gavnlige oplysninger om den anmodning, der blev behandlet. Naviger bare til overskriftsfanen i svarafsnittet for at se på svaroverskrifterne.

Et vigtigt punkt at bemærke her er, at alle de anmodninger, du fremsætter til serveren, er gemt i postbogshistorikken til fremtidig reference (fanen Historie er tilgængelig i venstre sidepanel i appen).

Dette hjælper med at forhindre oprettelsen af ​​anmodninger hver gang du har brug for at få svar på den samme anmodning og hjælper også med at undgå verdslige kedelpladeopgaver. Hvis det er nødvendigt, kan du henvise til tidligere anmodninger (og svar også) på et fremtidigt tidspunkt.

Bemærk: For at illustrere eksempler på anmodninger og svar bruger vi offentligt tilgængelige falske API-servere, der gør det muligt at foretage alle typer HTTP-anmodninger, og som returnerer et gyldigt HTTP-svar.

For at nævne et par stykker bruger vi nedenstående falske API-slutpunktsider som reference:

1. Rest API-eksempel
2. JSON pladsholder typicode

Alternativ Quick Postman Installationsvejledning

POSTMAN er et åbent værktøj og er tilgængeligt for alle, der surfer på internettet. Du kan følge nedenstående trin og få POSTMAN-værktøjet installeret i din lokale maskine.

Trin 1: Åben Google og søg efter POSTMAN-værktøjet. Du får nedenstående søgeresultat. Derefter kan du klikke på Download Postman App, og du bliver omdirigeret til getpostman-webstedet.

Ellers kan du direkte navigere til dette URL for at få POSTMAN-værktøjet.

Trin 2: Vælg POSTMAN-versionen baseret på dit operativsystem. I vores tilfælde skal vi bruge POSTMAN til Windows OS. Desuden bruger vi Window-64 bit, så vi downloader og installerer POSTMAN til 64 bit.

Trin 3: Når du har klikket på knappen Download, downloades en postman.exe-fil til dit lokale. Klik på den fil. Det er en installation med et enkelt klik ligesom alle andre applikationer, der giver dig mulighed for at installere POSTMAN-tilføjelsen til din browser.

Trin 4: Når du har installeret applikationen, skal du klikke på applikationen (som skal placeres på skrivebordet). Som du kan se i nedenstående billede, har vi seks forskellige enheder, som du grundlæggende har brug for tre byggesten for, dvs. anmodning, samling og miljø, som vil blive diskuteret i det næste afsnit.

Det er det!! Vi har med succes installeret og lanceret POSTMAN-applikationen.

Byggesten til POSTMAN

POSTMAN har en række byggesten, men til vores formål vil vi diskutere de tre store byggesten, der er vigtige for enhver POSTMAN-operation.

Disse tre store byggesten er:

# 1) Anmodning

En anmodning er intet andet end en kombination af den komplette URL (som inkluderer alle parametre eller nøgler), HTTP-headere, body eller nyttelast. Disse attributter danner helt en anmodning. POSTMAN giver dig mulighed for at gemme din anmodning, og dette er en god funktion i appen, der lader os bruge den samme anmodning så mange gange, som vi ønsker.

Klik på Ny -> Anmodning

# 2) Samling

Der skal være noget, hvor du gemmer dine bulkanmodninger. Dette er scenariet, hvor samlingen kommer ind i billedet. Vi kan sige, at en samling er et lager, hvor vi kan gemme alle vores anmodninger. Generelt opbevares de anmodninger, der rammer den samme API, i den samme samling.

Klik på Ny -> Samling.

# 3) Miljø

Et miljø er en region, hvor alle dine operationer på en API finder sted. Det kan være TUP, QA, Dev, UAT eller PROD. Hvert projekt vil allerede have regionerne konfigureret, og du skal bare erklære dine globale variabler såsom URL, tokens id og adgangskode, kontekstnøgler, API-nøgler, dokumentnøgler og så videre i det.

Klik på Nyt -> Miljø.

Gemme en anmodning til indsamling

Nu vil vi prøve at gemme en prøveanmodning i en samling, og vi vil bruge den samme anmodning til at ramme en API.

Trin 1: I øverste højre hjørne vil du se knappen “+ Ny”. Klik på denne knap, så får du listen over de byggesten, der blev vist, da du startede applikationen for første gang.

Trin 2: Klik på Anmod.

Trin 3: Angiv anmodningsnavnet, som er et obligatorisk felt. Klik derefter på “+ Opret samling”.

Trin 4: Når du har klikket på “+ Opret samling”, vil den bede om et navn (f.eks. Prøveindsamling). Indtast navnet på samlingen, og tryk på Enter.

Trin 5: Klik på 'Gem i prøveindsamling' knap.

Eksempel på anmodning og svar

Dette særlige afsnit giver dig et dybt indblik i, hvordan du tester en API i POSTMAN.

Som du kan se i nedenstående billede, har vi vores anmodning, som vi allerede har oprettet (Test for SoftwareTestingHelp). Desuden kan du se en rullemenu (lige ved siden af ​​URL'en), der indeholder de verb eller metoder, der understøttes af POSTMAN.

Disse kaldes HTTP-verb. Vi forsøger at opdatere noget ved hjælp af PUT-metoden, og derefter henter vi det samme ved hjælp af GET-metoden. Jeg antager, at læsere er opmærksomme på funktionaliteten af ​​disse HTTP-verber, der bruges i API-test.

Nu har vi en URL og en anmodningsmetode. Alt, hvad vi har brug for, er overskrifter og nyttelast eller krop. I nogle tilfælde er vi nødt til at generere tokens (baseret på behovene i en API).

Vi erklærer vores HTTP-overskrifter, dvs. indholdstype og accept. Accept er ikke altid obligatorisk, da det bestemmer formatet, hvor vi vil hente vores svar. Som standard er svaret altid JSON.

Der er ingen grund til at kramme værdierne for disse overskrifter, da POSTMAN giver dig forslagene, når du skriver tekstområderne for nøglen og værdien.

Derefter går vi videre til det næste obligatoriske afsnit, som er organ. Her giver vi nyttelasten i form af JSON. Vi er opmærksomme på, hvordan vi skriver vores egen JSON, derfor vil vi forsøge at skabe vores egen JSON.

Eksempel på anmodning

URL: http://www.mocky.io/v2/5cd6c3f23000004b006061c5

hvordan man skriver junit test tilfælde i java

Overskrifter

Indholdstype: applikation / JSON
Accepter = applikation / JSON

Legeme

Hit det nu

Når du har en komplet anmodning, skal du klikke på “Send-knappen” og se svarkoden. En 200 OK-kode står for vellykket drift. På billedet nedenfor kan du se, at vi med succes har ramt URL'en.

Det næste trin

Nu udfører vi en anden operation kaldet GET. Vi vil forsøge at hente den samme post, som vi lige har oprettet.

Vi kræver ikke en krop eller nyttelast til GET-operationen. Da vi allerede har vores prøveanmodning ved hjælp af PUT-metoden, er alt, hvad vi har brug for, at ændre metoden til GET.

Når vi har skiftet til GET, rammer vi tjenesten igen. Som du kan se i nedenstående billede, har vi nøjagtigt det, vi passerede, og det er sådan POSTMAN fungerer.

Opdatering: Yderligere oplysninger

Hvad er en API?

API (Application Programming Interface) er en jar-fil, der indeholder flere metoder og grænseflader til at udføre en bestemt handling.

Se nedenstående eksempel og skærmbillede:

1. Opret en summetode, der tilføjer to variabler og returnerer summen af ​​to variabler.
2. Opret derefter en lommeregnerklasse, der indeholder flere andre metoder som addition, subtraktion, multiplikation, division og så videre. Der kan også være nogle hjælperklasser. Nu skal du kombinere alle klasser og grænseflader, oprette en jar-fil kaldet Calculator.jar og derefter offentliggøre den. Brug Calculator API til at få adgang til de metoder, der findes indeni.
3. Nogle API'er er open source (Selenium), som kan redigeres, og andre er licenserede (UFT), som ikke kan redigeres.

Foreslået læsning => Top API-styringsværktøjer

Hvordan bliver disse metoder nøjagtigt kaldt?

Udviklere udsætter en grænseflade, en platform til at kalde lommeregnerens API, og vi opretter objektet til lommeregnerklassen og kalder summetoden eller en hvilken som helst metode.

Antag, at denne calculator.jar-fil er oprettet af et firma, og de bruger dette værktøj via UI-interface, så tester vi denne calculator-applikation ved hjælp af UI og automatiserer den ved hjælp af QTP / Selen, og dette kaldes Front End Testing.

Nogle applikationer har ikke brugergrænseflade, så for at få adgang til disse metoder opretter vi et objekt af klassen og videresender argumenterne til test, og dette kaldes Back-End-test . Afsendelse af anmodningen og modtagelse af svaret sker gennem JSON / XML-filer.

Se nedenstående diagram:

POSTMAN-klient

• POSTMAN er en REST-klient, der bruges til at udføre backend API-test.
• I POSTMAN passerer vi API-opkaldet og kontrollerer API-svaret, statuskoder og nyttelast.
• Swagger er et andet HTTP-klientværktøj, hvor vi opretter API-dokumentation, og gennem swagger kan vi også ramme API'en og få svaret.
• Se linket https://swagger.io/
• Du kan bruge enten Swagger eller POSTMAN til at teste API'erne, og det afhænger af virksomhederne, hvilken klient der skal bruges.
• I POSTMAN bruger vi mest GET, POST, PUT og SLET opkald.

Hvordan downloades POSTMAN Client?

Åbn Google Chrome, og download POSTMAN-appen, der er tilgængelig i Chrome-appbutikken.

Ring til REST API'er ved hjælp af POSTMAN Client

I POSTMAN fik vi mange metoder, men vi bruger kun GET, PUT, POST og SLET

• STOLPE - Dette opkald opretter en ny enhed.
• FÅ - Dette opkald sender anmodningen og modtager svaret.
• SÆTTE - Dette opkald opretter en ny enhed og opdaterer den eksisterende enhed.
• SLET - Dette opkald sletter den eksisterende enhed.

API'er kan tilgås enten ved hjælp af UI som bankplatform eller hvor UI ikke er tilgængeligt ligesom backend-systemer, hvor vi bruger REST API-klient som POSTMAN.

Andre klienter er også tilgængelige som SOAP UI, som er en REST- og SOAP-klient, avancerede REST-klienter som JMeter kan ringe til API'erne direkte fra browseren. POSTMAN er det bedste værktøj til udførelse af POST- og GET-operationer.

Læs også => Liste over dybdegående SoapUI-vejledninger

Send en anmodning og få svar i POSTMAN Client:

Til testformål bruger vi de leverede API'er her .

Kontroller hvert CRUD-opkald i POSTMAN-klienten ved hjælp af API'erne, der leveres af dummy-webstedet.

I API-test validerer vi hovedsageligt nedenstående punkter:

• Svarets statuskoder, se wiki-side for detaljer.
• Svarmeddelelsen og JSON-responsorganet.
• Ved API-test skal du først bede udvikleren om at angive slutpunktets URL. Se denne slutpunkts-URL https://reqres.in/.

# 1) FÅ OPKALD

Afsender anmodningen og modtager svaret.

Trin til test af REST API:

• Passere https://reqres.in//api/users?page=2 (? er en forespørgselsparameter, der filtrerer resultatet ud som at udskrive alle brugerens oplysninger på side 2, forespørgselsparameteren afhænger af udvikleren, hvordan de vil definere) som URI i POSTMAN-klienten.
• Forespørgselsparameteren er defineret af (?) Og styparameteren er defineret af (/).
• Vælg GET-metoden.

• Giv overskrifter (om nødvendigt) som User-Agent: 'Software'.

• Klik på knappen SEND.
• Hvis API fungerer fint, som svar får vi:
  • Status 200 - OK, det betyder, at svaret modtages med succes.
  • Svar JSON nyttelast.
  • Strengmeddelelse

• En anden Eksempel af GET METODE, hvor vi søgte efter oplysninger om en bestemt bruger, dvs. bruger-id = 3. Indtast URI = https://reqres.in/api/users/3

• Hvis data ikke er tilgængelige i forhold til vores søgning, får vi blank JSON- og 404-statusmeddelelse.

# 2) POST-opkald

Opret en ny bruger eller en enhed.

Trin til udførelse:

• Vælg en POST i rullemenuen, og brug denne service-URL 'https://reqres.in/api/users/100'
  
• Gå til Body -> vælg RAW -> Som vi passerer JSON.
• Vælg JSON i rullemenuen, og indsæt nyttelasteskriptet.
• Videregiv denne nyttelast {'name': 'Morpheus', 'job': 'leader'}

• JSON starter med krøllede seler og gemmer data i nøgleværdiformatet.
• Send overskriftens indholdstype = application / json.
• Tryk på knappen SEND.

• Efter vellykket anmodning får vi nedenstående svar:
  • Status 201 - Oprettet, svaret modtages med succes.
  • Svar nyttelast
  • Header

# 3) PUT-opkald

Opdaterer eller opretter en ny enhed.

Trin til oprettelse af PUT-opkald:

• Brug denne service-URL 'https://reqres.in/api/users/206' og nyttelast {'name': 'Morpheus', 'job': 'Manager'
• Gå til POSTMAN-klienten, og vælg PUT-metode -> Gå til Body -> Vælg RAW> send JSON, og vælg JSON fra rullemenuen, og indsæt nyttelasteskriptet.
• JSON starter med krøllede seler og gemmer data i nøgleværdiformatet.
• Tryk på knappen SEND for at få en vellykket anmodning får du nedenstående svar.
  • Status 200 - Ok, svaret er modtaget med succes.
  • Svar nyttelast
  • Header
  • Job opdateret til 'manager'

# 4) Slet opkald

• Slet brugeren, brug denne service-URL “/ api / brugere / 423” og denne nyttelast {“navn”: “Naveen”, ”job”: “QA”}.
• Gå til POSTMAN, og vælg SLET metode, nyttelast kræves ikke.
• Sletter bruger-id = 423, hvis det er tilgængeligt i systemet.
  • Status 204 - Intet indhold, svaret blev modtaget med succes.
  • Ingen nyttelast modtaget, bruger-id slettet.
  • Header

Udfordringer i API-test

• Testcases skal udformes på en sådan måde, at det skal dække testdækning.
• Design af testcases er enkle, når API'en har færre parametre, men kompleksiteten øges, når antallet af parametre er stort.
• Opdater jævnligt din testdækning med en ændring i forretningskravet. Hvis der tilføjes en ny parameter, skal du øge testsele-pakken
• Sekventering af API-opkald korrekt.
• Udforsk randbetingelser og ydeevne.

Konklusion

I denne vejledning diskuterede vi de vigtige henvisninger til at komme i gang med Postman API-testværktøjet. Vi lærte at installere Postman-værktøjet som en enkeltstående applikation og diskuterede, hvordan vi kan gå til at oprette en simpel anmodning og se på det genererede svar.

Vi så, hvordan vi navigerer til de forskellige dele af svaroplysningerne, samt hvordan vi gennemgår og henter anmodningerne fra historikfanen.

Vi mener, at du nu kan udføre en vellykket operation på en API. Vellykket operation på en API betyder ikke kopiering og indsætning af hele kroppen, overskrifter og andre nødvendige blokke og gør testudførelsen vellykket.

Det handler om, hvor behagelig du har det med at skrive din egen JSON, navigere til et bestemt felt i en JSON ved hjælp af dokumentnøglen eller parametre, forstå arrays i JSON osv.

POSTMAN-klientværktøjet bruges til at udføre back-end-test og hovedsagelig til at udføre GET, PUT, POST, SLET opkald.

Fra denne vejledning lærte vi, hvordan man rammer opkaldene fra POSTMAN-klienten, og hvordan man validerer det svar, som vi får tilbage fra serveren, og dækkede også udfordringerne i API-test.

API-test er meget vigtigt for at finde smuthuller i API'er, da hackere vil udnytte dem og forårsage økonomiske tab. API-test virker enkel, men vi skal være meget forsigtige og prøve at teste med alle mulige kombinationer.

I vores kommende tutorial lærer vi, hvordan du bruger Postman-værktøjet til Diff API-formater!

PREV-vejledning | NÆSTE vejledning

Anbefalet læsning

• Parasoft SOAtest Tutorial: Scriptless API Test Tool
• API-testvejledning: En komplet guide til begyndere
• Bedste softwaretestværktøjer 2021 (QA Test Automation Tools)
• Destruktiv test og ikke-destruktiv testvejledning
• Funktionel testning mod ikke-funktionel testning
• Vejledning til WAVE-tilgængelighedstestværktøj
• Vejledning til testning af tilgængelighed (En komplet trinvis vejledning)
• SOA Testing Tutorial: Testing Methodology For a SOA Architecture Model