REST Assured API-testingsveiledning

Hva er trygg?

Vær trygg lar deg teste REST APIer ved å bruke java-biblioteker og integreres godt med Maven. Den har svært effektive matchingsteknikker, så det er ganske enkelt å hevde de forventede resultatene dine. Rest Assured har metoder for å hente data fra nesten alle deler av forespørselen og svaret uansett hvor komplekse JSON-strukturene er.

For testfellesskapet er API Automation Testing fortsatt nytt og nisje. JSON-kompleksitetene holder API-testing uutforsket. Men det gjør det ikke mindre viktig i testprosessen. Rest Assured.io-rammeverket har gjort det veldig enkelt ved å bruke grunnleggende java-grunnlag, noe som gjør det til en veldig ønskelig ting å lære.

Hvorfor trenger du være trygg?

Tenk deg at du åpner din Google Kartvisning og søk etter et sted du vil dra til. Du ser umiddelbart restauranter i nærheten, pendleralternativer fra ledende reisebyråer og mange valgmuligheter lett tilgjengelig. Vi vet alle at dette ikke er tilfelle. Google produkter, så hvordan fungerer det Google klarer å vise dem? Den bruker de eksponerte API-ene til disse leverandørene. Hvis du blir bedt om å teste denne typen oppsett, selv før brukergrensesnittet er bygget eller under utvikling, blir testing av API-er ekstremt viktig. Å teste dem gjentatte ganger med forskjellige datakombinasjoner gjør det til et veldig passende tilfelle for automatisering.

Tidligere brukte team dynamiske språk som Groovy og Ruby for å oppnå dette, og det var utfordrende. Derfor ble ikke API-testing utforsket mye av funksjonelle testere.

Med Rest Assured blir det imidlertid enkelt å automatisere testing av API-er og sende enkle HTTPS-forespørsler med brukervennlige tilpasninger hvis man har grunnleggende kunnskap om JavaDet er nyttig for å forstå API-testing og integrasjonstesting. Rest Assured gir sterk tillit til backend, mens frontend-testere kan fokusere på brukergrensesnittet og klientsideoperasjoner. Rest Assured er åpen kildekode, og den konstante tilføyelsen av metoder og biblioteker har gjort det til et godt valg for API-automatisering.

REST Assured vs. Postman: Viktige forskjeller

Både REST Assured og Postman validere REST API-er, men hver passer til et annet stadium i testsyklusen. Valg av riktig verktøy avhenger av teamets ferdigheter, prosjektets omfang og integrasjonsbehov.

Aspekt	Vær trygg	Postman
typen	Java bibliotek for kodebasert automatisering	GUI-basert API-klient med skriptstøtte
Beste brukstilfelle	Kontinuerlige integrasjonsrørledninger og regresjonspakker	Manuell utforskning og raske API-sjekker
Ferdighetskrav	Kjerne Java kunnskap som kreves	Minimal koding; bruksområder JavaSkriptutdrag
Rapportering	Integreres med TestNG, JUnitog Allure	Innebygde kjøresammendrag via Newman CLI

Mange lag bruker Postman for tidlig prototypeping og bytt til REST Assured for automatisert regresjon når API-et er konfigurerttract stabiliserer seg.

Hvordan sette opp Rest Assured.io med Eclipse

Oppsett av REST Assured innebærer tre kjerneavhengigheter: Java, en IDE og Maven. Følg trinnene nedenfor for å unngå byggefeil senere.

Trinn 1) Installer Java. Viser til dette veilede

Trinn 2) Last ned en IDE for å begynne: eclipse

Trinn 3) Installer Maven og sett opp formørkelsen. Henvise her..

Oppsett Vær trygg

1. Opprett et Maven-prosjekt i IDE-en din. Vi bruker IntelliJ, men du vil få en lignende struktur på alle IDE-er du bruker.
2. Åpne POM.xml-filen din.

Prosjektstruktur for et REST Assured Maven-arbeidsområde

For Rest Assured.io: For Java versjon < 9 brukere:

Legg til avhengigheten nedenfor til din POM.xml:

<dependency>
<groupId>io.rest-assured</groupId>
<artifactId>json-path</artifactId>
<version>4.2.0</version>
<scope>test</scope>
</dependency>


<dependency>
<groupId>io.rest-assured</groupId>
<artifactId>xml-path</artifactId>
<version>4.2.0</version>
<scope>test</scope>
</dependency>


<dependency>
<groupId>io.rest-assured</groupId>
<artifactId>json-schema-validator</artifactId>
<version>4.2.0</version>
<scope>test</scope>
</dependency>

For Rest Assured.io: For Java brukere av versjon 9+:

<dependency>
<groupId>io.rest-assured</groupId>
<artifactId>rest-assured-all</artifactId>
<version>4.2.0</version>
<scope>test</scope>
</dependency>

Feilsøking:

Hvis du ser feil og er usikker på om avhengighetene ble lastet ned riktig, følger du disse trinnene:

1. Utfør en Maven-bygg for å importere alle avhengigheter. Du finner hjelp med Maven-oppsett på Guru99.
2. Hvis feilene vedvarer, kjør en Maven-opprydding etterfulgt av en Maven-installasjon. Byggingen skal fullføres uten feil.
3. Legg til importene nedenfor i din Java klassen og bekreft at det ikke er noen kompileringsfeil.

import io.restassured.RestAssured.*;
import io.restassured.matcher.RestAssuredMatchers.*;
import org.hamcrest.Matchers.*;

Første enkle Vær trygg-manus

Med avhengigheter på plass kan du nå skrive ditt første skript. Rammeverket følger en atferdsdrevet utviklingsstil (BDD) som leses nesten som engelsk.

Syntaks:

Syntaksen til Rest Assured.io er den mest lesbare delen av rammeverket, da den er veldig BDD-lignende og forståelig.

Given().
        param("x", "y").
        header("z", "w").
when().
Method().
Then().
        statusCode(XXX).
        body("x", "y", equalTo("z"));

Forklaring:

Code	Forklaring
Gitt()	Nøkkelordet «Given» lar deg angi en bakgrunn. Her sender du forespørselsoverskrifter, spørrings- og stiparametere, brødtekst og informasjonskapsler. Dette er valgfritt hvis disse elementene ikke er nødvendige i forespørselen.
Når()	Nøkkelordet «når» markerer premisset for scenarioet ditt. For eksempel «når» du får/publiserer/legger ut noe, gjør noe annet.
Metode()	Erstatt dette med en hvilken som helst av CRUD-operasjonene (get/post/put/delete).
Da()	Dine påstands- og matcherbetingelser plasseres her.

Nå som du har oppsettet og litt bakgrunnsinformasjon om syntaksen, la oss lage vår første enkle test. Det er greit om strukturen virker ny for deg. Etter hvert som du koder videre og tolker hver linje, vil du få taket på den.

Hva skal du hente?

Åpne nettleseren og trykk - https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1. Sørg for at du ser noe som nedenfor.

Eksempel på API-svar fanget av REST Assured

Hvis du får en feilmelding i nettleseren når du prøver å få svar på forespørselen:

1. Sjekk om du brukte HTTPS eller HTTP. Nettleseren din kan ha innstillinger som blokkerer usikre nettsteder.
2. Sjekk om en proxy eller brannmur blokkerer nettleseren din fra å åpne nettstedet.

*Merknader – du brukte ingen overskrifter her, ingen brødtekst og ingen informasjonskapsel. Det var en URL, og du henter innhold fra API-et i stedet for å legge ut eller oppdatere eksisterende innhold. Det gjør det til et GET-kall. Husk dette for å forstå vår første test bedre.

Målet med testen din:

Målet med skriptet er å skrive ut samme utdata på IDE-konsollen som det du mottok på nettleseren gjennom Rest Assured.

La oss kode dette med trinnene nedenfor:

Får respons Body

Trinn 1) Opprett en klasse med navnet «myFirstRestAssuredClass».

Trinn 2) Opprett en metode som heter «getResponseBody».

Trinn 3) I likhet med strukturen vi lærte tidligere for gitt, når og deretter, skriver du inn koden nedenfor:

gitt(). -> Ingen overskrifter kreves, ingen spørring eller baneparam.

when(). -> Ingen spesifikk betingelse satt opp.

bli('https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1'). -> bare URL må leveres.

then(). -> Ingen spesifikke påstander kreves.

log().all() -> Når alt svaret er hentet, logges svaret, overskriftene og i hovedsak alt som forespørselen returnerer til deg.

public static void getResponseBody(){
   given().when().get("https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1").then().log()
  .all();

}

Legg nå merke til at URL «used» er langt og mindre lesbart. Ved nærmere ettersyn vil du legge merke til at tre spørreparametere brukes:

1. Customer_ID
2. Passord
3. Konto_nr

Rest Assured hjelper oss med å sende hver del (spørring, sti, headerparameter) separat, noe som gjør koden mer lesbar og enkel å vedlikeholde. Vi kan også parameterisere dataene fra en ekstern fil etter behov.

For bruk av spørringsparam går vi tilbake til vår definisjon av syntaksen og ser at alle blir sendt som en del av gitt.

public static void getResponseBody(){

   given().queryParam("CUSTOMER_ID","68195")
           .queryParam("PASSWORD","1234!")
           .queryParam("Account_No","1")
           .when().get("https://demo.guru99.com/V4/sinkministatement.php").then().log()
           .body();
}

**Merk at vi brukte «body» i stedet for «all»; dette hjelper oss med å forståtracbare selve svaret.

Utgang:

Henter svarstatuskoden

Den neste metoden vi bruker som skript er å hente statuskoden og legge inn en påstand for å validere den.

Trinn 1) Opprett en metode kalt getResponseStatus().

Trinn 2) Bruk samme forespørselsstruktur som er brukt ovenfor. Kopier og lim den inn.

Trinn 3) I stedet for å logge det, bruk 'getStatus'.Code' innebygde metoden i Rest Assured for å hente statuskodeverdien.

Trinn 4) For å bekrefte at statuskoden din er 200, bruk nøkkelordene – assertThat().statusCode(forventetCode).

**Merk – URL er en variabel som brukes for enkelhets skyld. URL inneholder hele API-forespørselen URL.

public static void getResponseStatus(){
   int statusCode= given().queryParam("CUSTOMER_ID","68195")
           .queryParam("PASSWORD","1234!")
           .queryParam("Account_No","1") .when().get("https://demo.guru99.com/V4/sinkministatement.php").getStatusCode();
   System.out.println("The response status is "+statusCode);

   given().when().get(url).then().assertThat().statusCode(200);
}

Utgang:

Forretningsbehov

En av de grunnleggende reglene for automatisering er at vi må sette sjekkpunkter slik at testen fortsetter bare hvis alle nødvendige betingelser er oppfylt. I API-testing er den mest grunnleggende valideringen å sjekke om statuskoden for forespørselen er i 2XX-format.

Den komplette koden, så langt:

import java.util.ArrayList;
import static io.restassured.RestAssured.*;
import static java.util.concurrent.TimeUnit.MILLISECONDS;

public class myFirstRestAssuredClass {

   final static String url="https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1";

   public static void main(String args[]) {

      getResponseBody();
     getResponseStatus();

; }

   //This will fetch the response body as is and log it. given and when are optional here
   public static void getResponseBody(){
       given().when().get(url).then().log()
      .all();

  given().queryParam("CUSTOMER_ID","68195")
               .queryParam("PASSWORD","1234!")
               .queryParam("Account_No","1") .when().get("https://demo.guru99.com/V4/sinkministatement.php").then().log().body();
   }

public static void getResponseStatus(){
   int statusCode= given().queryParam("CUSTOMER_ID","68195")
           .queryParam("PASSWORD","1234!")
           .queryParam("Account_No","1")
           .when().get("https://demo.guru99.com/V4/sinkministatement.php").getStatusCode();
   System.out.println("The response status is "+statusCode);

   given().when().get(url).then().assertThat().statusCode(200);
}

}

* Merk:

1. 200 er et vellykket svar for dette scenariet. Noen ganger kan det hende at forespørselen mislykkes, og i så fall kan du bruke 4XX eller 5XX. Prøv å endre statuskoden ved å oppgi ugyldige parametere og sjekk.
2. Når vi hevder en betingelse, blir det ingen utskrift på konsollen med mindre det er en feil.

Skript for å hente ulike deler av et svar

Utover svartekst og statuskode, eksponerer REST Assured også overskrifter, responstid og innholdstype gjennom kjedebare eks.tractor-metoder. Nøkkelordet 'extract' er viktig for å hente disse spesifikke delene.

Header

Vær trygg er et veldig enkelt språk, og det er like enkelt å hente overskrifter. Metodenavnet er headers(). Som før vil vi lage en frittstående metode for å gjøre det samme.

public static void getResponseHeaders(){
   System.out.println("The headers in the response "+
                   get(url).then().extract()
           .headers());
}

Vær oppmerksom på at «given().when()» hoppes over her, og kodelinjen starter fra get(). Dette er fordi det ikke gjøres noen forutsetning eller verifisering før forespørselen sendes og et svar mottas. I slike tilfeller er det valgfritt å bruke det samme.

Utgang:

Bedriftsbehov:

Ganske ofte må du bruke autorisasjonstokenet eller en øktinformasjonskapsel for den påfølgende forespørselen, og disse detaljene returneres vanligvis som overskrifter i svaret.

Responstid

For å få tiden som trengs for å hente svaret fra backend eller andre nedstrømssystemer, tilbyr Rest Assured en metode kalt 'timeIn' med en passende timeUnit for å få tiden det tar å returnere svaret.

public static void getResponseTime(){
  System.out.println("The time taken to fetch the response "+get(url)
         .timeIn(TimeUnit.MILLISECONDS) + " milliseconds");
}

Utgang:

Bedriftsbehov:

En svært viktig funksjon ved testing av API-er er responstiden deres, som måler applikasjonens ytelse. Tiden det tar for samtalen din kan ta mer eller mindre tid avhengig av internetthastigheten din, API-ens ytelse på det tidspunktet, serverbelastning og andre faktorer som påvirker tiden.

Content-Type

Du kan få innholdstypen til svaret som returneres ved å bruke metoden «contentType()».

public static void getResponseContentType(){
   System.out.println("The content type of response "+
           get(url).then().extract()
              .contentType());
}

Produksjon

Bedriftsbehov:

Noen ganger er det viktig å få tak i innholdstypen for å sikre at det ikke er noen sikkerhetshull for trusler på tvers av opprinnelse, og for å bekrefte at innholdet som sendes er i henhold til API-standardene.

Hent individuelt JSON-element

Fra det gitte svaret blir du bedt om å beregne totalbeløpet. Du må hente hvert beløp og summere det.

Fremgangsmåte:

Trinn 1) Beløpsfeltet er innenfor en matrise med nøkkelen «setninger», som igjen er i listen med nøkkelen «resultat».

Trinn 2) Rest Assured tilbyr en mekanisme for å nå verdiene i API-et ved hjelp av «sti».

Trinn 3) Stien for å nå beløp er «result.statements.AMOUNT». Tenk på det som XPath i Selenium.

Trinn 4) Hent alle beløp i en samling, og gå deretter gjennom alle verdiene i løkke for å beregne summen.

public static void getSpecificPartOfResponseBody(){

ArrayList<String> amounts = when().get(url).then().extract().path("result.statements.AMOUNT") ;
int sumOfAll=0;
for(String a:amounts){

    System.out.println("The amount value fetched is "+a);
    sumOfAll=sumOfAll+Integer.valueOf(a);
}
System.out.println("The total amount is "+sumOfAll);

}

Merk: Siden beløpsverdien er en strengdatatype, konverterer vi den til et heltall for summering.

Utgang:

Beste praksis for REST Assured Test Automation

Når du forstår det grunnleggende, vil bruk av disiplinerte mønstre holde suiten din pålitelig etter hvert som API-overflaten vokser. Fremgangsmåtene nedenfor hjelper team med å unngå ustabile tester og vedlikeholdskostnader.

1. Sentraliser basen URL: Lagre basis-URI-en og autentiseringstokenene i én konfigurasjonsklasse eller egenskapsfil. Dette unngår duplisering og forenkler miljøbytte.
2. Bruk spesifikasjoner for forespørsler og svar: Bygg gjenbrukbare RequestSpecBuilder- og ResponseSpecBuilder-objekter. De reduserer standardkravene når mange tester deler felles overskrifter eller påstander.
3. Valider JSON-skjema: Kombiner REST Assured med json-schema-validator-modulen for å bekrefte konformitettract integritet. Skjemakontroller fanger opp endringer som ikke fungerer før de når nedstrøms forbrukere.
4. Eksternaliser testdata: Lagre nyttelaster i JSON-filer eller bruk dataleverandører fra TestNGHardkodede data blir raskt foreldet.
5. Kjør uavhengige tester: Hver test bør sette opp og rive ned sine egne data. Ordreavhengige suiter feiler uforutsigbart i parallelle CI-kjøringer.
6. Selektiv registrering av logger: Bruk log().ifError() i stabile pakker og log().all() under feilsøking. Utførlig loggføring av trege CI-pipeliner og skjuler reelle problemer.
7. Koble til CI/CD: Utløs REST Assured-pakker gjennom Maven Surefire eller Failsafe i Jenkins, GitHub Actions eller GitLab. Kjør røykkontroller på hver commit og full regresjon over natten.

Å ta i bruk disse vanene tidlig gjør API-automatisering til en langsiktig ressurs snarere enn en skjør flaskehals.

Spørsmål og svar