REST Assured API-testvejledning

Hvad er rolig?

Stol trygt på giver dig mulighed for at teste REST API'er ved hjælp af java-biblioteker og integrerer godt med Maven. Det har meget effektive matchningsteknikker, så det er også ret ligetil at hævde dine forventede resultater. Rest Assured har metoder til at hente data fra næsten alle dele af anmodningen og svaret, uanset hvor komplekse JSON-strukturerne er.

For testfællesskabet er API Automation Testing stadig nyt og niche. JSON-kompleksiteten holder API-test uudforsket. Men det gør det ikke mindre vigtigt i testprocessen. Rest Assured.io frameworket har gjort det meget enkelt ved at bruge grundlæggende java-grundlag, hvilket gør det til en meget ønskværdig ting at lære.

Hvorfor skal du være rolig?

Forestil dig, at du åbner din Google Se Kort og søg efter et sted, du gerne vil hen. Du ser straks restauranter i nærheden, pendlermuligheder fra førende rejseudbydere og mange valgmuligheder lige ved hånden. Vi ved alle, at disse ikke er Google produkter, så hvordan gør Google formår at vise dem? Den bruger disse udbyderes eksponerede API'er. Hvis du bliver bedt om at teste denne type opsætning, selv før brugergrænsefladen er bygget eller under udvikling, bliver test af API'er ekstremt vigtigt. Gentagen testning af dem med forskellige datakombinationer gør det til et meget velegnet tilfælde for automatisering.

Tidligere brugte teams dynamiske sprog som f.eks. Groovy og Ruby for at opnå dette, og det var udfordrende. Derfor blev API-testning ikke udforsket bredt af funktionelle testere.

Med Rest Assured bliver automatiseringstestning af API'er og afsendelse af simple HTTPS-anmodninger med brugervenlige tilpasninger dog enkelt, hvis man har en grundlæggende baggrund i JavaDet er nyttigt til forståelse af API-testning og integrationstest. Rest Assured giver stærk tillid til backend, mens frontend-testere kan fokusere på brugergrænsefladen og klientsideoperationer. Rest Assured er open source, og den konstante tilføjelse af metoder og biblioteker har gjort det til et godt valg til API-automatisering.

REST Assured vs. Postman: Nøgleforskelle

Både REST Assured og Postman validere REST API'er, men hver især passer til et forskelligt stadie i testlivscyklussen. Valg af det rigtige værktøj afhænger af dit teams færdigheder, projektets omfang og integrationsbehov.

Aspect	Vær sikker	Postman
Type	Java bibliotek til kodebaseret automatisering	GUI-baseret API-klient med scripting-understøttelse
Bedste Use Case	Kontinuerlige integrationspipelines og regressionssuiter	Manuel udforskning og hurtige API-tjek
Færdighedskrav	Core Java krævet viden	Minimal kodning; anvendelser JavaScriptstykker
Rapportering	Integreres med TestNG, JUnitog Allure	Indbyggede kørselsoversigter via Newman CLI

Mange hold bruger Postman til tidlig prototypeping og skift til REST Assured for automatiseret regression, når API'en er færdigtract stabiliserer sig.

Sådan konfigurerer du Rest Assured.io med Eclipse

Opsætning af REST Assured involverer tre kerneafhængigheder: Java, et IDE og Maven. Følg nedenstående trin for at undgå build-fejl senere.

Trin 1) Installer Java. Henvis til dette vejlede

Trin 2) Download en IDE for at begynde: Eclipse

Trin 3) Installer Maven og opsæt din formørkelse. Henvis link..

Opsætning Vær sikker

1. Opret et Maven-projekt i dit IDE. Vi bruger IntelliJ, men du vil få en lignende struktur på ethvert IDE, du måtte bruge.
2. Åbn din POM.xml.

Projektstruktur for et REST Assured Maven-arbejdsområde

For Rest Assured.io: For Java version < 9 brugere:

Tilføj nedenstående afhængighed 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 Brugere af version 9+:

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

Fejlfinding:

Hvis du ser fejl og ikke er sikker på, om afhængighederne blev downloadet korrekt, skal du følge disse trin:

1. Udfør en Maven-build for at importere alle afhængigheder. Du kan finde hjælp til Maven-opsætning på Guru99.
2. Hvis fejlene fortsætter, skal du køre en Maven-oprydning efterfulgt af en Maven-installation. Bygget burde fuldføres uden fejl.
3. Tilføj nedenstående importfiler i din Java klasse og bekræft, at der ikke er nogen kompileringsfejl.

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

Første simple Vær sikker script

Med afhængigheder på plads kan du nu skrive dit første script. Frameworket følger en adfærdsdrevet udviklingsstil (BDD), der læses næsten som engelsk.

Syntaks:

Syntaksen i Rest Assured.io er den mest læsbare del af frameworket, da den er meget 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
Givet()	Nøgleordet 'Given' giver dig mulighed for at angive en baggrund. Her angiver du anmodningsheadere, forespørgsels- og stiparametre, brødtekst og cookies. Dette er valgfrit, hvis disse elementer ikke er nødvendige i anmodningen.
Hvornår()	Nøgleordet 'når' markerer præmissen for dit scenarie. For eksempel, 'når' du får/opslår/lægger noget, så gør noget andet.
Metode()	Erstat dette med en hvilken som helst af CRUD-operationerne (get/post/put/delete).
Derefter()	Dine assert- og matcher-betingelser placeres her.

Nu hvor du har opsætningen og lidt baggrund for syntaksen, lad os lave vores første simple test. Det er okay, hvis strukturen virker ny for dig. Efterhånden som du koder videre og fortolker hver linje, vil du få styr på den.

Hvad vil du hente?

Åbn din browser og tryk - https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1. Sørg for, at du ser noget som nedenfor.

Eksempel på API-svar indsamlet af REST Assured

Hvis du får en fejl i browseren, når du forsøger at få et svar på anmodningen:

1. Tjek om du brugte HTTPS eller HTTP. Din browser har muligvis indstillinger, der blokerer usikre websteder.
2. Tjek om en proxy eller firewall blokerer din browser fra at åbne webstedet.

*Bemærk – du brugte ingen overskrifter her, ingen brødtekst og ingen cookie. Det var en URL, og du henter indhold fra API'en i stedet for at poste eller opdatere eksisterende indhold. Det gør det til et GET-kald. Husk dette for bedre at forstå vores første test.

Formålet med din test:

Målet med scriptet er at udskrive det samme output på din IDE-konsol, som det du modtog på browseren gennem Rest Assured.

Lad os kode dette med nedenstående trin:

Får svaret Body

Trin 1) Opret en klasse med navnet “myFirstRestAssuredClass”.

Trin 2) Opret en metode kaldet "getResponseBody".

Trin 3) I lighed med den tidligere lærte struktur for given, when og then, skal du skrive nedenstående kode:

givet(). -> Ingen headers påkrævet, ingen forespørgsel eller stiparam.

when(). -> Ingen specifik betingelse opsat.

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

then(). -> Ingen specifikke påstande kræves.

log(). all() -> Når alt svaret er hentet, logges svaret, headerne og stort set alt, hvad anmodningen returnerer til dig.

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();

}

Bemærk nu, at URL `used` er langt og mindre læsbart. Ved nærmere eftersyn vil du bemærke, at der bruges 3 forespørgselsparametre:

1. Kunde ID
2. Adgangskode
3. Konto_nr

Rest Assured hjælper os med at sende hver del (forespørgsel, sti, headerparameter) separat, hvilket gør koden mere læsbar og nem at vedligeholde. Vi kan også parametrisere dataene fra en ekstern fil efter behov.

For at bruge forespørgselsparam går vi tilbage til vores definition af syntaksen og ser, at dem alle videregives som en del af given.

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();
}

**Bemærk at vi brugte "body" i stedet for "all"; dette hjælper os med at forståtrackun selve svaret.

Output:

Henter svarstatuskoden

Den næste metode, vi vil bruge som script, er at hente statuskoden og lave en assertion for at validere den.

Trin 1) Opret en metode kaldet getResponseStatus().

Trin 2) Brug den samme anmodningsstruktur som ovenfor. Kopiér og indsæt det.

Trin 3) I stedet for at logge det, brug 'getStatus'.Code' indbyggede metode i Rest Assured til at hente statuskodeværdien.

Trin 4) For at bekræfte, at din statuskode er 200, skal du bruge nøgleordene – assertThat().statusCode(forventetCode).

**Bemærk – URL er en variabel, der bruges for enkelhedens skyld. URL indeholder hele API-anmodningen 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);
}

Output:

Forretningsbehov

En af de grundlæggende regler for automatisering er, at vi skal sætte kontrolpunkter, så testen kun fortsætter, hvis alle de krævede betingelser er opfyldt. I API-testning er den mest grundlæggende validering at kontrollere, om statuskoden for anmodningen er i 2XX-format.

Den komplette kode indtil videre:

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);
}

}

* Bemærk:

1. 200 er et vellykket svar i dette scenarie. Til tider kan det være nødvendigt, at anmodningen mislykkes, i hvilket tilfælde du kan bruge 4XX eller 5XX. Prøv at ændre statuskoden ved at angive ugyldige parametre, og kontroller.
2. Når vi hævder en betingelse, vil der ikke være nogen udskrivning på konsollen, medmindre der er en fejl.

Script til at hente forskellige dele af et svar

Ud over svartekst og statuskode eksponerer REST Assured også headere, svartid og indholdstype via kædelige eksempler.tractor-metoder. Nøgleordet 'ex'tract' er afgørende for at hente disse specifikke dele.

Header

Vær sikker er et meget ligetil sprog, og det er lige så enkelt at hente overskrifter. Metodens navn er headers(). Som før vil vi oprette en selvstændig metode til at gøre det samme.

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

Bemærk venligst, at 'given().when()' springes over her, og kodelinjen starter fra get(). Dette skyldes, at der ikke foretages nogen forudsætning eller verifikation, før anmodningen behandles og et svar modtages. I sådanne tilfælde er det valgfrit at bruge det samme.

Output:

Forretningsbehov:

Ofte skal du bruge autorisationstokenet eller en sessionscookie til den efterfølgende anmodning, og disse oplysninger returneres oftest som headere i svaret.

Responstid

For at få den nødvendige tid til at hente svaret fra backend eller andre downstream-systemer, leverer Rest Assured en metode kaldet 'timeIn' med en passende timeUnit til at få den tid, det tager at returnere svaret.

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

Output:

Forretningsbehov:

En meget vigtig funktion ved test af API'er er deres svartid, som måler applikationens ydeevne. Den tid, det tager for dit opkald, kan tage mere eller mindre tid afhængigt af din internethastighed, API'ens ydeevne på det tidspunkt, serverbelastningen og andre faktorer, der påvirker tiden.

Content-Type

Du kan få indholdstypen for det returnerede svar ved hjælp af metoden “contentType()”.

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

Produktion

Forretningsbehov:

Til tider er det vigtigt at finde indholdstypen for at sikre, at der ikke er sikkerhedshuller i forbindelse med trusler på tværs af oprindelse, og for at bekræfte, at det overførte indhold er i overensstemmelse med API'ens standarder.

Hent individuelt JSON-element

Ud fra det givne svar bliver du bedt om at beregne det samlede beløb. Du skal hente hvert beløb og lægge det sammen.

Trin:

Trin 1) Beløbsfeltet er inden for et array med nøglen "udsagn", som igen er på listen med nøglen "resultat".

Trin 2) Rest Assured tilbyder en mekanisme til at nå værdierne i API'en ved hjælp af "path".

Trin 3) Stien til at nå beløb er "result.statements.AMOUNT". Tænk på det som XPath i Selenium.

Trin 4) Hent alle beløb i en samling, og gennemgå derefter alle værdier for at 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);

}

Bemærk: Da amount-værdien er en strengdatatype, konverterer vi den til et heltal for at summere.

Output:

Bedste praksis for REST Assured Test Automation

Når du først har forstået det grundlæggende, vil anvendelsen af ​​disciplinerede mønstre sikre, at din suite forbliver pålidelig, efterhånden som API-overfladen vokser. Fremgangsmåderne nedenfor hjælper teams med at undgå ustabile tests og vedligeholdelsesomkostninger.

1. Centraliser basen URL: Gem basis-URI'en og godkendelsestokens i en enkelt konfigurationsklasse eller egenskabsfil. Dette undgår dobbeltarbejde og forenkler miljøskift.
2. Brug af specifikationer for anmodninger og svar: Byg genanvendelige RequestSpecBuilder- og ResponseSpecBuilder-objekter. De reducerer standardteksten, når mange tests deler fælles headere eller assertions.
3. Valider JSON-skema: Kombinér REST Assured med json-schema-validator-modulet for at bekræfte konformitettract integritet. Skematjek fanger ændringer, der ikke fungerer, før de når downstream-forbrugere.
4. Eksternaliser testdata: Gem nyttelast i JSON-filer eller brug dataudbydere fra TestNGHardkodede data bliver hurtigt forældede.
5. Kør uafhængige tests: Hver test bør opsætte og nedbryde sine egne data. Ordreafhængige suiter fejler uforudsigeligt i parallelle CI-kørsler.
6. Selektiv indfangning af logfiler: Brug log().ifError() i stabile suiter og log().all() under fejlfinding. Udførlige logfiler langsommer CI-pipelines og skjuler reelle problemer.
7. Tilslut til CI/CD: Udløs REST Assured-pakker via Maven Surefire eller Failsafe i Jenkins, GitHub Actions eller GitLab. Kør smoke checks på hver commit og fuld regression natten over.

Tidlig implementering af disse vaner gør API-automatisering til et langsigtet aktiv snarere end en skrøbelig flaskehals.

Ofte Stillede Spørgsmål