Samouczek testowania interfejsu API REST Assured

Co to jest pewność spokoju?

Zapewniam cię umożliwia testowanie interfejsów API REST przy użyciu bibliotek Java i dobrze integruje się z Maven. Posiada bardzo wydajne techniki dopasowywania, więc potwierdzenie oczekiwanych wyników jest również dość proste. Rest Assured ma metody pobierania danych z niemal każdej części żądania i odpowiedzi, niezależnie od tego, jak złożone są struktury JSON.

Dla społeczności testującej testowanie automatyzacji API jest wciąż czymś nowym i niszowym. Złożoność JSON sprawia, że ​​testowanie API pozostaje niezbadane. Ale to nie czyni go mniej ważnym w procesie testowania. Framework Rest Assured.io uczynił to bardzo prostym, wykorzystując podstawowe podstawy języka Java, co czyni go bardzo pożądanym przedmiotem do nauki.

Dlaczego potrzebujesz Rest-Assured?

Wyobraź sobie, że otwierasz Google Przeglądaj mapy i szukaj miejsc, do których chcesz się udać. Od razu zobaczysz pobliskie restauracje, opcje dojazdu od wiodących biur podróży i wiele opcji na wyciągnięcie ręki. Wszyscy wiemy, że to nie jest… Google produkty, więc jak to działa Google Jak je wyświetlić? Wykorzystuje on udostępnione API tych dostawców. Jeśli zostaniesz poproszony o przetestowanie takiej konfiguracji, jeszcze przed stworzeniem lub rozwojem interfejsu użytkownika, testowanie API staje się niezwykle ważne. Wielokrotne testowanie ich z różnymi kombinacjami danych sprawia, że ​​jest to bardzo odpowiedni przypadek do automatyzacji.

Wcześniej zespoły korzystały z dynamicznych języków, takich jak Groovy i Ruby, aby to osiągnąć, i było to trudne. W związku z tym testowanie API nie było szeroko eksplorowane przez testerów funkcjonalnych.

Jednak dzięki Rest Assured automatyczne testowanie interfejsów API i wysyłanie prostych żądań HTTPS z przyjaznymi dla użytkownika dostosowaniami staje się proste, jeśli ktoś ma podstawową wiedzę na temat JavaJest pomocny w zrozumieniu testowania API i testów integracyjnych. Rest Assured daje dużą pewność w zakresie back-endu, podczas gdy testerzy front-endu mogą skupić się na interfejsie użytkownika i operacjach po stronie klienta. Rest Assured jest oprogramowaniem typu open source, a ciągłe dodawanie metod i bibliotek sprawiło, że jest to doskonały wybór do automatyzacji API.

REST Assured vs Postman: Kluczowe różnice

Zarówno REST Assured, jak i Postman Walidacja interfejsów API REST, ale każde z nich pasuje do innego etapu cyklu testowania. Wybór odpowiedniego narzędzia zależy od umiejętności zespołu, zakresu projektu i potrzeb integracyjnych.

WYGLĄD	Zapewniony odpoczynek	Postman
Typ	Java biblioteka do automatyzacji opartej na kodzie	Klient API oparty na interfejsie graficznym z obsługą skryptów
Najlepszy przypadek użycia	Ciągłe procesy integracji i zestawy regresji	Ręczna eksploracja i szybkie kontrole API
Wymagania dotyczące umiejętności	rdzeń Java wymagana wiedza	Minimalne kodowanie; używa JavaFragmenty skryptu
Raportowanie	Integruje się z TestNG, JUniti Allure	Wbudowane podsumowania przebiegów za pośrednictwem interfejsu wiersza poleceń Newman

Wiele zespołów korzysta Postman dla wczesnego prototypuping i przejdź na REST Assured w celu automatycznej regresji, gdy API będzie gotowetract się stabilizuje.

Jak skonfigurować Rest Assured.io za pomocą Eclipse

Wdrożenie usługi REST Assured wymaga spełnienia trzech podstawowych zależności: Java, IDE i Maven. Wykonaj poniższe kroki, aby uniknąć błędów kompilacji w przyszłości.

Krok 1) Zainstaluj Java. Zapoznaj się z tym

Krok 2) Pobierz IDE, aby rozpocząć: zaćmienie

Krok 3) Zainstaluj Maven i skonfiguruj eclipse. Zapoznaj się z w tym miejscu.

Konfiguracja jest pewna

1. Utwórz projekt Maven w swoim IDE. My używamy IntelliJ, ale podobną strukturę uzyskasz w dowolnym używanym IDE.
2. Otwórz plik POM.xml.

Struktura projektu dla obszaru roboczego Maven z certyfikatem REST

Aby mieć pewność.io: Dla Java wersja < 9 użytkowników:

Dodaj poniższą zależność do pliku 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>

Aby mieć pewność.io: Dla Java użytkownicy wersji 9+:

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

Rozwiązywanie problemów:

Jeśli widzisz błędy i nie masz pewności, czy zależności zostały poprawnie pobrane, wykonaj następujące kroki:

1. Wykonaj kompilację Maven, aby zaimportować wszystkie zależności. Pomoc dotyczącą konfiguracji Maven znajdziesz tutaj. Guru99.
2. Jeśli błędy nadal występują, uruchom czyszczenie Mavena, a następnie instalację Mavena. Kompilacja powinna zakończyć się bez błędów.
3. Dodaj poniższe importy do swojego Java klasę i sprawdź, czy nie ma błędów kompilacji.

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

Pierwszy prosty skrypt typu Rest Assured

Po skonfigurowaniu zależności możesz teraz napisać swój pierwszy skrypt. Framework wykorzystuje styl programowania sterowanego zachowaniem (BDD), który brzmi niemal jak język angielski.

Składnia:

Składnia Rest Assured.io jest najbardziej czytelną częścią struktury, ponieważ jest bardzo podobna do BDD i zrozumiała.

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

Wyjaśnienie:

Code	Wyjaśnienie
Dany()	Słowo kluczowe „Given” pozwala ustawić tło. W tym miejscu przekazujesz nagłówki żądania, parametry zapytania i ścieżki, treść oraz pliki cookie. Jest to opcjonalne, jeśli te elementy nie są potrzebne w żądaniu.
Gdy()	Słowo kluczowe „kiedy” oznacza założenie Twojego scenariusza. Na przykład „kiedy” coś otrzymasz/opublikujesz/umieścisz, a zrobisz coś innego.
Metoda()	Zastąp tę operację dowolną operacją CRUD (get/post/put/delete).
Następnie()	Tutaj należy wpisać warunki potwierdzenia i dopasowania.

Skoro masz już konfigurację i podstawy składni, utwórzmy nasz pierwszy prosty test. Nic nie szkodzi, jeśli struktura wydaje Ci się nowa, ale w miarę dalszego kodowania i interpretacji każdej linijki, załapiesz o co chodzi.

Co przyniesiesz?

Otwórz przeglądarkę i naciśnij – https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1. Upewnij się, że widzisz coś jak poniżej.

Przykładowa odpowiedź API przechwycona przez REST Assured

W przypadku, gdy podczas próby uzyskania odpowiedzi na żądanie w przeglądarce pojawi się błąd:

1. Sprawdź, czy użyłeś protokołu HTTPS czy HTTP. Twoja przeglądarka może mieć ustawienia blokujące niebezpieczne witryny.
2. Sprawdź, czy jakiś serwer proxy lub zapora sieciowa nie blokuje Twojej przeglądarce możliwości otwarcia witryny.

*Note – nie użyłeś tu żadnych nagłówków, treści ani pliku cookie. To było URL, a Ty pobierasz zawartość z API, zamiast publikować lub aktualizować istniejącą zawartość. To sprawia, że ​​jest to wywołanie GET. Zapamiętaj to, aby lepiej zrozumieć nasz pierwszy test.

Cel Twojego testu:

Celem skryptu jest wydrukowanie na konsoli IDE tych samych danych wyjściowych, które otrzymałeś w przeglądarce za pośrednictwem usługi Rest Assured.

Zakodujmy to, wykonując poniższe kroki:

Uzyskiwanie treści odpowiedzi

Krok 1) Utwórz klasę o nazwie „myFirstRestAssuredClass”.

Krok 2) Utwórz metodę o nazwie „getResponseBody”.

Krok 3) Podobnie do struktury, której nauczyłeś się wcześniej, czyli „give”, „When”, a następnie wpisz poniższy kod:

dany(). -> Nie są wymagane żadne nagłówki, żadne zapytania ani parametry ścieżki.

kiedy(). -> Brak określonego ustawienia warunku.

Dostawać('https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1'). -> tylko URL musi zostać dostarczone.

then(). -> Nie są wymagane żadne konkretne potwierdzenia.

log(). all() -> Po pobraniu całej odpowiedzi, zapisz odpowiedź, nagłówki i zasadniczo wszystko, co żądanie do Ciebie zwróci.

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

}

Teraz zauważ, że URL użyto jest długie i mniej czytelne. Przyglądając się uważnie, zauważysz, że używane są 3 parametry zapytania:

1. Identyfikator klienta
2. Hasło
3. Nr konta

Rest Assured pomaga nam przekazywać każdą część (zapytanie, ścieżkę, parametr nagłówka) osobno, dzięki czemu kod jest bardziej czytelny i łatwiejszy w utrzymaniu. Możemy również parametryzować dane z pliku zewnętrznego, jeśli zajdzie taka potrzeba.

Aby użyć parametru zapytania, wracamy do naszej definicji składni i widzimy, że wszystkie z nich są przekazywane jako część podanego.

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

**Należy pamiętać, że użyliśmy słowa „body” zamiast „all”; pomaga nam to np.tractylko treść odpowiedzi.

Wyjście:

Uzyskiwanie kodu stanu odpowiedzi

Następną metodą, którą pokażemy, będzie pobranie kodu statusu i umieszczenie potwierdzenia w celu jego sprawdzenia.

Krok 1) Utwórz metodę o nazwie getResponseStatus().

Krok 2) Użyj tej samej struktury żądania, co powyżej. Skopiuj i wklej.

Krok 3) Zamiast rejestrować, użyj 'getStatusCodeWbudowana metoda Rest Assured służąca do pobierania wartości kodu statusu.

Krok 4) Aby potwierdzić, że kod statusu wynosi 200, użyj słów kluczowych assertThat().statusCode(oczekiwanyCode).

**Notatka - URL jest zmienną używaną dla uproszczenia. URL przechowuje całe żądanie 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);
}

Wyjście:

Potrzeba biznesowa

Jedną z podstawowych zasad automatyzacji jest to, że musimy ustawić punkty kontrolne tak, aby test przebiegał tylko wtedy, gdy zostaną spełnione wszystkie wymagane warunki. W testowaniu API najbardziej podstawową walidacją jest sprawdzenie, czy kod statusu żądania ma format 2XX.

Pełny kod, jak dotąd:

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

}

*Uwaga:

1. 200 to odpowiedź pomyślna w tym scenariuszu. Czasami może zaistnieć potrzeba niepowodzenia żądania, w takim przypadku należy użyć kodu 4XX lub 5XX. Spróbuj zmienić kod statusu, podając nieprawidłowe parametry i sprawdź.
2. Kiedy potwierdzimy warunek, na konsoli nie będzie drukowania, chyba że wystąpi błąd.

Skrypt pobierający różne części odpowiedzi

Oprócz treści odpowiedzi i kodu statusu, REST Assured udostępnia również nagłówki, czas odpowiedzi i typ zawartości za pomocą łańcuchowych przykładówtracmetody tor. Słowo kluczowe „ex”tracjest to niezbędne do pobrania tych konkretnych części.

Nagłówek

Rest Assured to bardzo prosty język, a pobieranie nagłówków jest równie proste. Nazwa metody to headers(). Podobnie jak poprzednio, stworzymy samodzielną metodę, aby zrobić to samo.

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

Należy pamiętać, że pominięto tutaj metodę „given().when()”, a wiersz kodu rozpoczyna się od metody „get(). Dzieje się tak, ponieważ przed wysłaniem żądania i otrzymaniem odpowiedzi nie ma żadnego warunku wstępnego ani weryfikacji. W takich przypadkach użycie tej samej metody jest opcjonalne.

wyjście:

Potrzeba biznesowa:

Często konieczne jest użycie tokena autoryzacyjnego lub pliku cookie sesji przy kolejnym żądaniu. Dane te są najczęściej zwracane jako nagłówki odpowiedzi.

Czas odpowiedzi

Aby uzyskać czas potrzebny na pobranie odpowiedzi z backendu lub innych systemów dalszych, Rest Assured udostępnia metodę o nazwie „timeIn” z odpowiednią jednostką czasu, aby uzyskać czas potrzebny na zwrócenie odpowiedzi.

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

Wyjście:

Potrzeba biznesowa:

Bardzo ważną cechą testowania API jest ich czas reakcji, który mierzy wydajność aplikacji. Czas oczekiwania na wywołanie może być dłuższy lub krótszy, w zależności od szybkości łącza internetowego, wydajności API w danym momencie, obciążenia serwera i innych czynników wpływających na czas.

Typ zawartości

Typ zawartości zwróconej odpowiedzi można uzyskać za pomocą metody „contentType()”.

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

Wydajność

Potrzeba biznesowa:

Czasami uzyskanie informacji o typie zawartości jest niezbędne, aby mieć pewność, że nie ma luk w zabezpieczeniach umożliwiających ataki międzydomenowe, a także w celu potwierdzenia, że ​​przekazywana zawartość jest zgodna ze standardami interfejsu API.

Pobierz indywidualny element JSON

Na podstawie podanej odpowiedzi zostaniesz poproszony o obliczenie kwoty całkowitej. Musisz pobrać każdą kwotę i ją zsumować.

Kroki:

Krok 1) Pole kwoty znajduje się w tablicy z kluczem „statements”, która z kolei znajduje się na liście z kluczem „result”.

Krok 2) Rest Assured udostępnia mechanizm umożliwiający dotarcie do wartości w API za pomocą „ścieżki”.

Krok 3) Ścieżka do osiągnięcia kwot to „result.statements.AMOUNT”. Pomyśl o tym jak o XPath w Selenium.

Krok 4) Pobierz wszystkie kwoty z kolekcji, a następnie przejrzyj wszystkie wartości, aby obliczyć sumę.

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

}

Uwaga: Ponieważ wartość kwoty jest typem danych łańcuchowych, w celu zsumowania konwertujemy ją na liczbę całkowitą.

Wyjście:

Najlepsze praktyki w zakresie automatyzacji testów REST Assured

Po zrozumieniu podstaw, stosowanie zdyscyplinowanych wzorców zapewni niezawodność pakietu w miarę rozwoju interfejsu API. Poniższe praktyki pomogą zespołom uniknąć niestabilnych testów i narzutu na konserwację.

1. Centralizacja bazy URL: Przechowuj podstawowy identyfikator URI i tokeny uwierzytelniające w jednej klasie konfiguracyjnej lub pliku właściwości. Pozwala to uniknąć duplikacji i uprościć przełączanie środowisk.
2. Użyj specyfikacji żądań i odpowiedzi: Twórz obiekty RequestSpecBuilder i ResponseSpecBuilder wielokrotnego użytku. Zmniejszają one liczbę szablonów, gdy wiele testów ma wspólne nagłówki lub asercje.
3. Sprawdź poprawność schematu JSON: Połącz REST Assured z modułem json-schema-validator, aby potwierdzić zgodnośćtracintegralności. Sprawdzanie schematu wychwytuje zmiany powodujące przerwanie działania systemu, zanim dotrą one do odbiorców końcowych.
4. Eksternalizacja danych testowych: Przechowuj ładunki w plikach JSON lub korzystaj z dostawców danych z TestNGZakodowane na stałe dane szybko stają się nieaktualne.
5. Uruchom niezależne testy: Każdy test powinien konfigurować i usuwać własne dane. Zestawy zależne od kolejności zawodzą w sposób nieprzewidywalny podczas równoległych uruchomień CI.
6. Selektywne przechwytywanie dzienników: Używaj log().ifError() w pakietach stabilnych i log().all() podczas debugowania. Szczegółowe logowanie spowalnia procesy CI i ukrywa rzeczywiste problemy.
7. Podłącz do CI/CD: Uruchom pakiety REST Assured za pomocą Maven Surefire lub Failsafe w Jenkins, GitHub Actions lub GitLab. Przeprowadzaj testy dymowe przy każdym zatwierdzeniu i pełną regresję w nocy.

Wczesne przyjęcie tych nawyków sprawia, że ​​automatyzacja API staje się atutem długoterminowym, a nie kruchym wąskim gardłem.

FAQ