Tutorial de testare API REST Assured

Ce este Fii sigur?

Fiți siguri vă permite să testați API-urile REST folosind biblioteci java și se integrează bine cu Maven. Are tehnici de potrivire foarte eficiente, așa că afirmarea rezultatelor așteptate este, de asemenea, destul de simplă. Rest Assured are metode pentru a prelua date din aproape fiecare parte a cererii și a răspunsului, indiferent cât de complexe sunt structurile JSON.

Pentru comunitatea de testare, API Automation Testing este încă nou și de nișă. Complexitățile JSON mențin testarea API-ului neexplorat. Dar asta nu îl face mai puțin important în procesul de testare. Cadrul Rest Assured.io a făcut-o foarte simplu folosind elementele de bază ale Java, ceea ce îl face un lucru foarte de dorit de învățat.

De ce ai nevoie de Rest-Assured?

Imaginează-ți că îți deschizi Google Vizualizați Hărți și căutați un loc unde doriți să mergeți. Vedeți imediat restaurante în apropiere, opțiuni de navetă de la furnizorii de servicii de călătorie de top și multe opțiuni la îndemână. Știm cu toții că acestea nu sunt Google produse, deci cum funcționează Google reușește să le afișeze? Folosește API-urile expuse ale acestor furnizori. Acum, dacă ți se cere să testezi acest tip de configurație, chiar înainte ca interfața cu utilizatorul să fie construită sau să fie în curs de dezvoltare, testarea API-urilor devine extrem de importantă. Testarea lor repetată cu diferite combinații de date o face un caz foarte potrivit pentru automatizare.

Anterior, echipele foloseau limbaje dinamice precum Groovy și Ruby pentru a realiza acest lucru, iar acest lucru a fost o provocare. Prin urmare, testarea API nu a fost explorată pe scară largă de către testerii funcționali.

Totuși, cu Rest Assured, testarea automatizată a API-urilor și trimiterea de cereri HTTPS simple cu personalizări ușor de utilizat devin simple dacă se au cunoștințe de bază despre... JavaEste util pentru înțelegerea testării API și a testării integrării. Rest Assured oferă o încredere puternică în backend, în timp ce testerii front-end se pot concentra pe interfața cu utilizatorul și pe operațiunile din partea clientului. Rest Assured este open source, iar adăugarea constantă de metode și biblioteci l-a transformat într-o alegere excelentă pentru automatizarea API-urilor.

REST Assured vs. Postman: Diferențele cheie

Atât REST Assured, cât și Postman validează API-urile REST, însă fiecare se potrivește unei etape diferite a ciclului de viață al testării. Selectarea instrumentului potrivit depinde de abilitățile echipei, de domeniul de aplicare al proiectului și de nevoile de integrare.

Aspect	Fiți siguri	Postman
Tip	Java bibliotecă pentru automatizare bazată pe cod	Client API bazat pe interfață grafică cu suport pentru scripting
Cel mai bun caz de utilizare	Conducte de integrare continuă și suite de regresie	Explorare manuală și verificări rapide ale API-ului
Cerință de abilități	Nucleu Java cunoștințe necesare	Codare minimală; utilizări JavaFragmente de script
Raportarea	Se integrează cu TestNG, JUnitși Allure	Rezumate de rulare încorporate prin intermediul interfeței de comandă Newman

Multe echipe folosesc Postman pentru prototipuri timpuriiping și treceți la REST Assured pentru regresie automată odată ce API-ul este contract se stabilizează.

Cum să configurați Rest Assured.io cu Eclipse

Configurarea REST Assured implică trei dependențe principale: Java, un IDE și Maven. Urmați pașii de mai jos pentru a evita erorile de compilare ulterioare.

Pasul 1) Instalați Java. Faceți referire la aceasta ghida

Pasul 2) Descărcați un IDE pentru a începe: eclipsă

Pasul 3) Instalați Maven și configurați-vă eclipsa. Consultați aici.

Configurare Fiți siguri

1. Creați un proiect Maven în IDE-ul dumneavoastră. Noi folosim IntelliJ, dar veți obține o structură similară pe orice IDE pe care îl utilizați.
2. Deschideți fișierul POM.xml.

Structura proiectului pentru un spațiu de lucru Maven REST Assured

For Rest Assured.io: Pentru Java versiunea < 9 utilizatori:

Adăugați dependența de mai jos la POM.xml dvs.:

<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: Pentru Java Utilizatori versiunea 9+:

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

Depanare:

În cazul în care observați erori și nu sunteți sigur dacă dependențele au fost descărcate corect, urmați acești pași:

1. Executați o compilare Maven pentru a importa toate dependențele. Veți găsi ajutor pentru configurarea Maven pe Guru99.
2. Dacă erorile persistă, executați o curățare Maven urmată de o instalare Maven. Compilarea ar trebui să se finalizeze fără erori.
3. Adăugați importurile de mai jos în Java clasa și confirmați că nu există erori de compilare.

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

Primul script simplu Rest Assured

Cu dependențele implementate, acum puteți scrie primul script. Framework-ul urmează un stil de dezvoltare bazată pe comportament (BDD) care se citește aproape ca limba engleză.

Sintaxă:

Sintaxa Rest Assured.io este cea mai ușor de citit parte a framework-ului, deoarece este foarte asemănătoare cu BDD și ușor de înțeles.

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

Explicaţie:

Code	Explicație
Dat()	Cuvântul cheie „Given” vă permite să setați un fundal. Aici, transmiteți anteturile cererii, parametrii de interogare și cale, corpul cererii și cookie-urile. Acest lucru este opțional dacă aceste elemente nu sunt necesare în cerere.
Când()	Cuvântul cheie „când” marchează premisa scenariului tău. De exemplu, „când” primești/postezi/puni ceva, fă altceva.
Metodă()	Înlocuiți aceasta cu oricare dintre operațiunile CRUD (get/post/put/delete).
Apoi()	Condițiile tale de afirmare și de potrivire se află aici.

Acum, că ai configurația și câteva cunoștințe despre sintaxă, hai să creăm primul nostru test simplu. Este în regulă dacă structura ți se pare nouă, pe măsură ce codezi mai departe și interpretezi fiecare linie, te vei obișnui cu ea.

Ce vei aduce?

Deschideți browserul și apăsați – https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1. Asigurați-vă că vedeți ceva ca mai jos.

Exemplu de răspuns API capturat de REST Assured

În cazul în care primiți o eroare în browser atunci când încercați să obțineți un răspuns la cerere:

1. Verifică dacă ai folosit HTTPS sau HTTP. Browserul tău ar putea avea setări care blochează site-urile web nesigure.
2. Verificați dacă vreun proxy sau firewall blochează browserul dvs. să deschidă site-ul web.

*notițe – nu ai folosit niciun antet aici, niciun corp și niciun cookie. A fost un URLși primiți conținut de la API în loc să postați sau să actualizați conținut existent. Aceasta îl face un apel GET. Rețineți acest lucru pentru a înțelege mai bine primul nostru test.

Obiectivul testului dvs.:

Scopul scriptului este de a imprima aceeași ieșire pe consola IDE ca ceea ce ați primit în browser prin Rest Assured.

Să codificăm acest lucru cu pașii de mai jos:

Obținerea răspunsului Body

Pas 1) Creați o clasă numită „myFirstRestAssuredClass”.

Pas 2) Creați o metodă numită „getResponseBody”.

Pas 3) Similar structurii învățate anterior pentru given, when și then, introduceți codul de mai jos:

dat(). -> Nu sunt necesare antete, nici un parametru de interogare sau cale.

când(). -> Nicio condiție specifică configurată.

obține('https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1'). -> doar URL trebuie furnizat.

then(). -> Nu sunt necesare aserțiuni specifice.

log().all() -> Odată ce toate răspunsurile sunt preluate, se înregistrează în jurnal răspunsul, anteturile și, practic, tot ceea ce vă returnează solicitarea.

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

}

Acum observați că URL „used” este lung și mai puțin lizibil. Privind cu atenție, veți observa că sunt utilizați 3 parametri de interogare:

1. Număr de înregistrare client
2. Parolă
3. Cont_Nr

Rest Assured ne ajută să transmitem fiecare parte (interogare, cale, parametru antet) separat, făcând codul mai lizibil și mai ușor de întreținut. De asemenea, putem parametriza datele dintr-un fișier extern, după cum este necesar.

Pentru a utiliza parametrul de interogare, ne întoarcem la definiția noastră a sintaxei și vedem că toate sunt transmise ca parte a datei.

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

**Rețineți că am folosit „corp” în loc de „tot”; acest lucru ne ajută să exprimămtracdoar corpul răspunsului.

ieșire:

Obținerea codului de stare a răspunsului

Următoarea metodă pe care o vom scrie în script este să obținem codul de stare și să plasăm o aserțiune pentru a-l valida.

Pas 1) Creați o metodă numită getResponseStatus().

Pas 2) Utilizați aceeași structură de solicitare folosită mai sus. Copiați și lipiți-l.

Pas 3) În loc să îl înregistrezi, folosește „getStatus”Code' metodă încorporată a Rest Assured pentru a obține valoarea codului de stare.

Pas 4) Pentru a afirma că codul dvs. de stare este 200, utilizați cuvintele cheie – assertThat().statusCode(așteptatCode).

**Notă – URL este o variabilă utilizată pentru simplitate. URL conține întreaga cerere API 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);
}

ieșire:

Nevoie de afaceri

Una dintre regulile de bază ale automatizării este că trebuie să punem puncte de control, astfel încât testul să continue numai dacă sunt îndeplinite toate condițiile cerute. În testarea API, cea mai simplă validare este verificarea dacă codul de stare al cererii este în format 2XX.

Codul complet, până acum:

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

}

*Notă:

1. 200 este un răspuns reușit pentru acest scenariu. Uneori, este posibil să fie nevoie ca solicitarea să eșueze, caz în care puteți utiliza 4XX sau 5XX. Încercați să modificați codul de stare furnizând parametri nevalidi și verificați.
2. Când afirmăm o condiție, nu va exista nicio imprimare pe consolă decât dacă există o eroare.

Script pentru a prelua diferite părți ale unui răspuns

Dincolo de corpul răspunsului și codul de stare, REST Assured expune și anteturile, timpul de răspuns și tipul de conținut prin intermediul unor exemple înlănțuibile.tracmetode tor. Cuvântul cheie „extract' este esențial pentru preluarea acestor părți specifice.

Antet

Rest Assured este un limbaj foarte simplu, iar preluarea antetelor este la fel de simplă. Numele metodei este headers(). Ca și înainte, vom crea o metodă independentă pentru a face același lucru.

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

Rețineți că „given().when()” este omisă aici, iar linia de cod începe de la get(). Acest lucru se datorează faptului că nu există nicio precondiție sau verificare efectuată înainte de a accesa cererea și a primi un răspuns. În astfel de cazuri, este opțional să o utilizați.

ieşire:

Nevoie de afaceri:

Destul de des, ar trebui să utilizați token-ul de autorizare sau un cookie de sesiune pentru solicitarea ulterioară, iar aceste detalii sunt returnate în mare parte ca anteturi ale răspunsului.

Timp De Raspuns

Pentru a obține timpul necesar pentru a prelua răspunsul de la backend sau alte sisteme din aval, Rest Assured oferă o metodă numită „timeIn” cu o unitate de timp adecvată pentru a obține timpul necesar pentru a returna răspunsul.

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

ieșire:

Nevoie de afaceri:

O caracteristică foarte importantă a testării API-urilor este timpul lor de răspuns, care măsoară performanța aplicației. Timpul necesar apelului poate fi mai mare sau mai mic, în funcție de viteza conexiunii la internet, performanța API-ului la momentul respectiv, încărcarea serverului și alți factori care influențează timpul.

Content-Type

Puteți obține tipul de conținut al răspunsului returnat folosind metoda „contentType()”.

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

producție

Nevoie de afaceri:

Uneori, obținerea tipului de conținut este esențială pentru a asigura că nu există lacune de securitate pentru amenințări de tip cross-source și pentru a confirma că respectivul conținut este conform standardelor API.

Preluați elementul JSON individual

Pe baza răspunsului dat, ți se cere să calculezi suma totală. Trebuie să aduci fiecare sumă și să o aduni.

Pași:

Pas 1) Câmpul „amount” se află într-o matrice cu cheia „statements”, care la rândul ei se află în lista cu cheia „result”.

Pas 2) Rest Assured oferă un mecanism pentru a ajunge la valorile din API folosind „cale”.

Pas 3) Calea pentru a ajunge la sume este „result.statements.AMOUNT”. Gândiți-vă la ea ca la XPath în Selenium.

Pas 4) Preia toate sumele dintr-o colecție, apoi parcurge toate valorile pentru a calcula suma.

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

}

Notă: Deoarece valoarea amount este un tip de date șir de caractere, o convertim într-un număr întreg pentru însumare.

ieșire:

Cele mai bune practici pentru automatizarea testelor REST Assured

Odată ce înțelegeți elementele de bază, aplicarea unor modele disciplinate menține suita fiabilă pe măsură ce suprafața API crește. Practicile de mai jos ajută echipele să evite testele instabile și cheltuielile suplimentare de întreținere.

1. Centralizați baza URL: Stocați URI-ul de bază și token-urile de autentificare într-o singură clasă de configurare sau fișier de proprietăți. Acest lucru evită duplicarea și simplifică schimbarea mediului.
2. Utilizați specificațiile de solicitare și răspuns: Construiește obiecte RequestSpecBuilder și ResponseSpecBuilder reutilizabile. Acestea reduc suprasolicitarea atunci când mai multe teste au anteturi sau aserțiuni comune.
3. Validarea schemei JSON: Combinați REST Assured cu modulul json-schema-validator pentru a confirma contracIntegritatea. Verificările schemei detectează modificările incompatibile înainte ca acestea să ajungă la consumatorii din aval.
4. Externalizarea datelor de testare: Stocați sarcini utile în fișiere JSON sau utilizați furnizori de date de la TestNGDatele codificate fix devin rapid învechite.
5. Executați teste independente: Fiecare test ar trebui să configureze și să elimine propriile date. Suitele dependente de ordine eșuează imprevizibil în rulările paralele ale CI.
6. Capturați jurnalele selectiv: Folosește log().ifError() în suitele stabile și log().all() în timpul depanării. Jurnalele detaliate încetinesc conductele CI și ascund problemele reale.
7. Conectați la CI/CD: Declanșați suitele REST Assured prin Maven Surefire sau Failsafe în Jenkins, Acțiuni GitHub sau GitLab. Rulați verificări de tip „smoke check” pentru fiecare commit și regresie completă peste noapte.

Adoptarea timpurie a acestor obiceiuri transformă automatizarea API-urilor într-un avantaj pe termen lung, mai degrabă decât într-un blocaj fragil.

Întrebări frecvente