REST Assured API-Test-Tutorial

Was ist Rest Assured?

Seien Sie versichert ermöglicht Ihnen das Testen von REST-APIs mithilfe von Java-Bibliotheken und lässt sich gut in Maven integrieren. Es verfügt über sehr effiziente Matching-Techniken, sodass auch die Feststellung Ihrer erwarteten Ergebnisse ziemlich unkompliziert ist. Rest Assured verfügt über Methoden zum Abrufen von Daten aus nahezu jedem Teil der Anfrage und Antwort, unabhängig davon, wie komplex die JSON-Strukturen sind.

Für die Test-Community ist das API-Automatisierungstesten noch neu und eine Nische. Die Komplexität von JSON hält das API-Testen unerforscht. Aber das macht es im Testprozess nicht weniger wichtig. Das Rest Assured.io-Framework hat es mithilfe der grundlegenden Java-Grundlagen sehr einfach gemacht, sodass es sehr erstrebenswert ist, es zu lernen.

Warum brauchen Sie Rest-Assured?

Stellen Sie sich vor, Sie öffnen Ihr Google Nutzen Sie die Kartenansicht, um nach einem gewünschten Ziel zu suchen. Sofort werden Ihnen Restaurants in der Nähe, Transportmöglichkeiten führender Reiseanbieter und viele weitere Optionen angezeigt. Wir alle wissen, dass dies nicht die Regel ist. Google Produkte, also wie funktioniert das? Google Wie können diese angezeigt werden? Dafür werden die bereitgestellten APIs dieser Anbieter verwendet. Wenn Sie nun aufgefordert werden, ein solches Setup zu testen, noch bevor die Benutzeroberfläche erstellt oder in Entwicklung ist, wird das Testen der APIs extrem wichtig. Wiederholte Tests mit verschiedenen Datenkombinationen machen dies zu einem idealen Anwendungsfall für die Automatisierung.

Früher verwendeten Teams dynamische Sprachen wie Groovy Um dies zu erreichen, benötigten wir Ruby, was sich als schwierig erwies. Daher wurde API-Testing von funktionalen Testern nicht umfassend genutzt.

Mit Rest Assured wird das automatisierte Testen von APIs und das Senden einfacher HTTPS-Anfragen mit benutzerfreundlichen Anpassungen jedoch unkompliziert, sofern man über grundlegende Kenntnisse verfügt. JavaRest Assured ist hilfreich für das Verständnis von API- und Integrationstests. Es bietet hohe Sicherheit im Backend, sodass sich Frontend-Tester auf die Benutzeroberfläche und clientseitige Operationen konzentrieren können. Rest Assured ist Open Source und die ständige Erweiterung um neue Methoden und Bibliotheken macht es zu einer hervorragenden Wahl für die API-Automatisierung.

REST Assured vs Postman: Hauptunterschiede

Sowohl REST Assured als auch Postman Es gibt zwar verschiedene Tools zur Validierung von REST-APIs, doch jedes eignet sich für eine andere Phase des Testzyklus. Die Wahl des richtigen Tools hängt von den Fähigkeiten Ihres Teams, dem Projektumfang und den Integrationsanforderungen ab.

Aspekt	Seien Sie versichert	Postman
Typ	Java Bibliothek für codebasierte Automatisierung	GUI-basierter API-Client mit Skriptunterstützung
besten Use Case	Kontinuierliche Integrationspipelines und Regressionstests	Manuelle Erkundung und schnelle API-Prüfungen
Fähigkeitsanforderung	Core Java Erforderliche Kenntnisse	Minimale Codierung; Verwendung JavaSkriptausschnitte
Reporting	Integriert mit TestNG, JUnitund Allure	Integrierte Laufzeitzusammenfassungen über die Newman-Befehlszeilenschnittstelle

Viele Teams nutzen Postman für frühe Prototypenping und wechseln Sie zu REST Assured für automatisierte Regressionstests, sobald die API-Konfiguration abgeschlossen ist.tract stabilisiert sich.

So richten Sie Rest Assured.io ein mit Eclipse

Die Einrichtung von REST Assured umfasst drei Kernabhängigkeiten: JavaSie benötigen eine IDE und Maven. Befolgen Sie die folgenden Schritte, um spätere Build-Fehler zu vermeiden.

Schritt 1) ​​Installieren Java. Beziehen Sie sich darauf Entwicklung

Schritt 2) Laden Sie zunächst eine IDE herunter: Eklipse

Schritt 3) Installieren Sie Maven und richten Sie Eclipse ein. Siehe werden auf dieser Seite erläutert.

Seien Sie versichert

1. Erstellen Sie ein Maven-Projekt in Ihrer IDE. Wir verwenden IntelliJ, aber die Projektstruktur ist in jeder anderen IDE ähnlich.
2. Öffnen Sie Ihre POM.xml-Datei.

Projektstruktur für einen REST Assured Maven-Arbeitsbereich

Für Rest Assured.io: Für Java Benutzer von Versionen < 9:

Fügen Sie die folgende Abhängigkeit zu Ihrer POM.xml hinzu:

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

Für Rest Assured.io: Für Java Benutzer der Version 9+:

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

Fehlerbehebung:

Falls Fehler auftreten und Sie sich nicht sicher sind, ob die Abhängigkeiten korrekt heruntergeladen wurden, befolgen Sie diese Schritte:

1. Führe einen Maven-Build durch, um alle Abhängigkeiten zu importieren. Hilfe zur Maven-Einrichtung findest du hier: Guru99
2. Falls weiterhin Fehler auftreten, führen Sie ein `Maven clean` und anschließend ein `Maven install` aus. Der Build sollte dann fehlerfrei abgeschlossen werden.
3. Fügen Sie die folgenden Importe in Ihre Java Prüfen Sie, ob Kompilierungsfehler vorliegen.

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

Erstes einfaches Rest Assured-Skript

Nachdem die Abhängigkeiten eingerichtet sind, können Sie nun Ihr erstes Skript schreiben. Das Framework folgt einem verhaltensgetriebenen Entwicklungsstil (BDD), der sich fast wie Englisch liest.

Syntax:

Die Syntax von Rest Assured.io ist der am besten lesbare Teil des Frameworks, da sie sehr BDD-ähnlich und verständlich ist.

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

Erläuterung:

Code	Erläuterung
Gegeben()	Mit dem Schlüsselwort „Given“ können Sie einen Hintergrund festlegen. Hier übergeben Sie die Anfrageheader, Abfrage- und Pfadparameter, den Anfragetext und die Cookies. Dies ist optional, falls diese Elemente in der Anfrage nicht benötigt werden.
Wann()	Das Schlüsselwort „wenn“ kennzeichnet die Prämisse Ihres Szenarios. Zum Beispiel: „Wenn“ Sie etwas erhalten/posten/hineinfügen, tun Sie etwas anderes.
Methode()	Ersetzen Sie dies durch eine der CRUD-Operationen (get/post/put/delete).
Dann()	Hier kommen Ihre Assert- und Matcher-Bedingungen hin.

Nachdem Sie nun die Einrichtung und einige Grundlagen der Syntax kennen, erstellen wir unseren ersten einfachen Test. Es ist völlig in Ordnung, wenn Ihnen die Struktur zunächst ungewohnt erscheint; mit der Zeit und durch das Interpretieren jeder Zeile werden Sie sie verstehen.

Was wirst du holen?

Öffnen Sie Ihren Browser und klicken Sie auf – https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1. Stellen Sie sicher, dass Sie Folgendes sehen.

Beispiel einer API-Antwort, erfasst von REST Assured

Falls beim Versuch, eine Antwort auf die Anfrage zu erhalten, ein Fehler im Browser auftritt:

1. Prüfen Sie, ob Sie HTTPS oder HTTP verwendet haben. Ihr Browser verfügt möglicherweise über Einstellungen, die unsichere Websites blockieren.
2. Prüfen Sie, ob ein Proxy oder eine Firewall Ihren Browser daran hindert, die Website zu öffnen.

*Hinweis – Sie haben hier keine Header, keinen Body und keine Cookies verwendet. Es war ein URLSie rufen also Inhalte von der API ab, anstatt bestehende Inhalte zu veröffentlichen oder zu aktualisieren. Daher handelt es sich um einen GET-Aufruf. Merken Sie sich das, um unseren ersten Test besser zu verstehen.

Das Ziel Ihres Tests:

Das Ziel des Skripts besteht darin, auf Ihrer IDE-Konsole dieselbe Ausgabe zu drucken, die Sie über Rest Assured im Browser erhalten haben.

Lassen Sie uns dies mit den folgenden Schritten codieren:

Den Antworttext abrufen

Schritt 1) Erstellen Sie eine Klasse namens „myFirstRestAssuredClass“.

Schritt 2) Erstellen Sie eine Methode namens „getResponseBody“.

Schritt 3) Ähnlich der zuvor kennengelernten Struktur aus gegeben, wenn und dann, geben Sie den folgenden Code ein:

gegeben(). -> Keine Header erforderlich, keine Abfrage oder Pfadparameter.

when(). -> Keine spezifische Bedingungseinstellung.

erhalten('https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1'). -> nur die URL muss geliefert werden.

then(). -> Keine spezifischen Zusicherungen erforderlich.

log().all() -> Sobald die gesamte Antwort abgerufen wurde, werden die Antwort, die Header und im Grunde alles, was die Anfrage zurückgibt, protokolliert.

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

}

Beachten Sie nun, dass URL Der verwendete Code ist lang und schwer lesbar. Bei genauerem Hinsehen erkennt man, dass drei Abfrageparameter verwendet werden:

1. Kundennummer
2. Passwort
3. Konto Nr

Rest Assured ermöglicht es uns, jeden Teil (Abfrage, Pfad, Header-Parameter) separat zu übergeben, wodurch der Code lesbarer und wartungsfreundlicher wird. Außerdem können wir die Daten bei Bedarf aus einer externen Datei parametrisieren.

Für die Verwendung von Abfrageparametern kehren wir zu unserer Definition der Syntax zurück und stellen fest, dass sie alle als Teil von gegeben übergeben werden.

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

**Beachten Sie, dass wir „body“ anstelle von „all“ verwendet haben; dies hilft uns dabei, die Darstellung zu vereinfachen.**tract nur der Hauptteil der Antwort.

Ausgang:

Den Antwortstatuscode abrufen

Die nächste Methode, die wir skripten werden, besteht darin, den Statuscode zu ermitteln und eine Assertion einzufügen, um ihn zu validieren.

Schritt 1) Erstellen Sie eine Methode namens getResponseStatus().

Schritt 2) Verwenden Sie dieselbe Anforderungsstruktur wie oben. Kopieren Sie es und fügen Sie es ein.

Schritt 3) Anstatt es zu protokollieren, verwenden Sie 'getStatus'.Code' integrierte Methode von Rest Assured zum Abrufen des Statuscodes.

Schritt 4) Um zu bestätigen, dass Ihr Statuscode 200 ist, verwenden Sie die Schlüsselwörter: assertThat().statusCode(erwartetCode).

**Notiz - URL ist eine Variable, die der Einfachheit halber verwendet wird. URL enthält die gesamte API-Anfrage 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);
}

Ausgang:

Geschäftsanforderungen

Eine der Grundregeln der Automatisierung besteht darin, dass wir Kontrollpunkte setzen müssen, damit der Test nur dann fortgesetzt wird, wenn alle erforderlichen Bedingungen erfüllt sind. Bei API-Tests besteht die grundlegendste Validierung darin, zu prüfen, ob der Statuscode der Anfrage im 2XX-Format vorliegt.

Der vollständige Code bisher:

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

}

* Hinweis:

1. In diesem Szenario ist der Statuscode 200 eine positive Antwort. Gelegentlich kann es jedoch erforderlich sein, dass die Anfrage fehlschlägt. In diesem Fall können Sie die Statuscodes 4XX oder 5XX verwenden. Versuchen Sie, den Statuscode durch die Angabe ungültiger Parameter zu ändern und prüfen Sie, ob die Antwort erfolgreich war.
2. Wenn wir eine Bedingung aktivieren, erfolgt kein Ausdruck auf der Konsole, es sei denn, es liegt ein Fehler vor.

Skript zum Abrufen verschiedener Teile einer Antwort

Neben Antworttext und Statuscode stellt REST Assured auch Header, Antwortzeit und Inhaltstyp über verkettbare Ausdrücke bereit.tracTor-Methoden. Das Schlüsselwort 'ex'tracEs ist unerlässlich, um diese spezifischen Teile zu beschaffen.

Kopfzeile

Rest Assured ist eine sehr unkomplizierte Sprache und das Abrufen von Headern ist genauso einfach. Der Methodenname ist headers(). Wie zuvor werden wir eine eigenständige Methode erstellen, um dasselbe zu tun.

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

Bitte beachten Sie, dass `given().when()` hier übersprungen wird und die Codezeile mit `get()` beginnt. Dies liegt daran, dass vor dem Absenden der Anfrage und dem Empfang der Antwort keine Vorbedingung oder Überprüfung durchgeführt wird. In solchen Fällen ist die Verwendung von `given().when()` optional.

Ausgang:

Geschäftsanforderungen:

In den meisten Fällen benötigen Sie für die nachfolgende Anfrage das Autorisierungstoken oder einen Session-Cookie, und diese Details werden meist als Header der Antwort zurückgegeben.

Reaktionszeit

Um die zum Abrufen der Antwort vom Backend oder anderen Downstream-Systemen benötigte Zeit zu ermitteln, stellt Rest Assured eine Methode namens „timeIn“ mit einer geeigneten timeUnit bereit, um die zum Zurücksenden der Antwort benötigte Zeit zu ermitteln.

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

Ausgang:

Geschäftsanforderungen:

Ein sehr wichtiges Merkmal beim Testen von APIs ist ihre Antwortzeit, die die Leistungsfähigkeit der Anwendung misst. Die Dauer eines API-Aufrufs kann je nach Internetgeschwindigkeit, API-Leistung zum Zeitpunkt des Aufrufs, Serverlast und anderen Einflussfaktoren variieren.

Content-Type

Den Inhaltstyp der zurückgegebenen Antwort können Sie mit der Methode „contentType()“ ermitteln.

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

Ausgang

Geschäftsanforderungen:

Manchmal ist die Ermittlung des Inhaltstyps unerlässlich, um sicherzustellen, dass keine Sicherheitslücken für ursprungsübergreifende Bedrohungen bestehen und um zu bestätigen, dass die übermittelten Inhalte den Standards der API entsprechen.

Einzelnes JSON-Element abrufen

Anhand der gegebenen Antwort sollen Sie den Gesamtbetrag berechnen. Dazu müssen Sie alle Einzelbeträge ermitteln und addieren.

Schritte:

Schritt 1) Das Feld „amount“ befindet sich in einem Array mit dem Schlüssel „statements“, welches wiederum in der Liste mit dem Schlüssel „reult“ enthalten ist.

Schritt 2) Rest Assured bietet einen Mechanismus, um über „path“ auf die Werte in der API zuzugreifen.

Schritt 3) Der Pfad, um die Beträge zu ermitteln, lautet „result.statements.AMOUNT“. Man kann sich das wie XPath vorstellen. Selenium.

Schritt 4) Alle Beträge in einer Sammlung abrufen und dann alle Werte durchlaufen, um die Summe zu berechnen.

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

}

Hinweis: Da der Betragswert vom Datentyp String ist, wandeln wir ihn zur Summation in eine Ganzzahl um.

Ausgang:

Best Practices für REST-konforme Testautomatisierung

Sobald Sie die Grundlagen verstanden haben, sorgt die Anwendung bewährter Vorgehensweisen für eine zuverlässige Testsuite, auch wenn die API-Oberfläche wächst. Die folgenden Praktiken helfen Teams, fehlerhafte Tests und einen hohen Wartungsaufwand zu vermeiden.

1. Zentralisierung der Basis URL: Speichern Sie die Basis-URI und die Authentifizierungstoken in einer einzigen Konfigurationsklasse oder Eigenschaftendatei. Dies vermeidet Redundanz und vereinfacht den Umgebungswechsel.
2. Anfrage- und Antwortspezifikationen verwenden: Erstellen Sie wiederverwendbare RequestSpecBuilder- und ResponseSpecBuilder-Objekte. Diese reduzieren den Boilerplate-Code, wenn viele Tests gemeinsame Header oder Assertions verwenden.
3. JSON-Schema validieren: Kombinieren Sie REST Assured mit dem Modul json-schema-validator, um die Übereinstimmung zu bestätigen.tracIntegritätsprüfungen des Schemas erkennen inkompatible Änderungen, bevor diese nachgelagerte Verbraucher erreichen.
4. Externalisieren von Testdaten: Speichern Sie Nutzdaten in JSON-Dateien oder verwenden Sie Datenanbieter von TestNGFest codierte Daten veralten schnell.
5. Unabhängige Tests durchführen: Jeder Test sollte seine eigenen Daten einrichten und abbauen. Reihenfolgeabhängige Testreihen schlagen bei parallelen CI-Läufen unvorhersehbar fehl.
6. Protokolle selektiv erfassen: Verwenden Sie `log().ifError()` in stabilen Testumgebungen und `log().all()` während des Debuggens. Ausführliche Protokolle verlangsamen CI-Pipelines und verschleiern eigentliche Probleme.
7. An CI/CD anbinden: REST Assured-Suites über Maven Surefire oder Failsafe auslösen Jenkins, GitHub Actions oder GitLab. Führen Sie bei jedem Commit Smoke-Checks und über Nacht eine vollständige Regression durch.

Wer sich diese Gewohnheiten frühzeitig aneignet, macht die API-Automatisierung zu einem langfristigen Vorteil und nicht zu einem fragilen Engpass.

Häufig gestellte Fragen