Cypress API-Tests meistern: Ein umfassender Leitfaden mit Beispielen

Anwendungsprogrammierschnittstellen, im Volksmund APIs genannt, sind ein wichtiger Aspekt des Softwareentwicklungslebenszyklus, nicht nur aus Entwicklersicht, sondern auch aus Testperspektive. Diese APIs erleichtern die Interaktion zwischen verschiedenen Systemen zum Austausch von Daten. Daher ist es äußerst wichtig, diese APIs gründlich zu testen, um ein reibungsloses Funktionieren der Anwendung sicherzustellen.

In diesem Artikel werden wir API-Tests mit dem Cypress Testing Framework untersuchen und sehen, wie wir unsere APIs für effiziente Tests automatisieren können. Wir werden die folgenden Punkte in diesem Artikel behandeln –

Überblick über API-Tests

API-Tests umfassen das Senden der HTTP-Anfrage, sei es GET, POST, PUT, DELETE (oder andere Methoden), an den Backend-Server und das Abrufen der Antworten. Sobald die Antworten abgerufen wurden, werden sie validiert, um sicherzustellen, dass die erwarteten Werte empfangen wurden. Einige wichtige Aspekte des API-Tests sind unten aufgeführt

• Überprüfung des Statuscodes – Die Überprüfung des Statuscodes in der Antwort erfolgt, um sicherzustellen, dass der gewünschte Statuscode empfangen wird. Beispielsweise werden 200 Statuscodes erwartet, um den Erfolg sicherzustellen. Weitere für HTTP-Anfragen verwendete Standardstatuscodes finden Sie in der Wiki-Dokumentation.
• Antworttext-Behauptungen –Validierung des HTTP-Antworttextes, um sicherzustellen, dass XML oder JSON die erwarteten Daten enthält und die richtige Struktur hat.
• Testen des Anforderungsparameters –Validierung des Verhaltens der API durch Übergabe verschiedener Werte in den Parametern und Headern.
• Authentifizierung und Autorisierung –Validierung des richtigen Authentifizierungsmechanismus und der Sicherheitsaspekte. Beim Testen der APIs werden die oben genannten Punkte berücksichtigt, um sicherzustellen, dass die End-to-End-Funktionalität der API fehlerfrei ist.

Verwendung von Cypress für API-Tests

Cypress ist ein beliebtes Front-End-Testtool, das für Browser- und End-to-End-Automatisierungstests verwendet wird. Cypress verfügt über Netzwerkanforderungsfunktionen, was es auch zu einer guten Wahl für API-Tests macht. Einige der wichtigsten Funktionen, die Cypress für API-Tests bietet, sind:

• Vertrautheit in der Syntax – Ähnlich wie die UI-Tests verwenden Cypress-API-Befehle dieselbe .should()- und .then()-Syntax.
• Eingebaute Behauptungen – Wir können die von Cypress bereitgestellten Behauptungen problemlos verwenden, um den Statuscode, die Header oder sogar den Antworttext von API-Anfragen zu bestätigen.
• Fehlgeschlagene Anfragen erneut versuchen – Cypress wiederholt fehlgeschlagene Anfragen automatisch, um sicherzustellen, dass kein Netzwerk- oder ähnliches Problem vorliegt.

Ausführliche Dokumentation – Cypress verfügt über gut dokumentierte Anfragen und Behauptungen, die es einfach machen, unterwegs Unterstützung zu erhalten.

Hauptfunktionen von Cypress API Testing

Cypress verfügt über eine Vielzahl von Funktionen, mit denen Sie API-Tests effektiv und effizient durchführen können. Einige Funktionen werden unten besprochen –

• cy.wait() – Bietet einen Mechanismus zum Warten auf eine Netzwerkanforderung und hilft beim Laden asynchroner Daten.
• cy.route() – Hilft beim Weiterleiten von Testanfragen an bestimmte Handler.
• cy.server() – hilft bei der Wartung eines gesamten Servers für eine Testsuite.
• Testläufer – Hilfe bei der parallelen Ausführung von Tests für eine schnelle Durchlaufzeit.
• cy.login() – Hilft bei der Durchführung sicherer API-Anfragen, indem Autorisierungsheader mit einem einzigen Befehl vor den Aufrufen festgelegt werden.
• cy.intercept() – Steuert die Antworten oder simuliert das Verhalten durch Abfangen der Anfragen. Mit diesen Funktionen wird es für den Benutzer sehr einfach und bequem, mit dem Schreiben der API-Tests mit erweiterten Funktionen und einem effizienten Framework zu beginnen.

Da wir nun verstanden haben, wie Cypress bei der Automatisierung unserer APIs helfen kann, schreiben wir einen einfachen API-Test mit Cypress. Zuvor müssen Sie jedoch sicherstellen, dass die folgenden Voraussetzungen erfüllt sind –

• Installieren Sie eine IDE wie Visual Studio (dies ist die am häufigsten verwendete IDE, Sie können aber auch auf eine andere IDE wie IntelliJ verweisen)
• Installieren Sie Node.js in Ihrem System Lassen Sie uns nun die Schritte zum Schreiben unseres ersten API-Tests mit Cypress durchgehen.

Schreiben des ersten API-Tests mit Cypress

In diesem Artikel behandeln wir ein einfaches Szenario des Sendens von HTTP-Anfragen mit den Methoden GET, POST, PUT und DELETE. Aber bevor wir mit dem Schreiben des Testskripts beginnen, richten wir die Umgebung ein.

1. Erstellen Sie einen Ordner lokal in Ihrem System. Ich habe in meinem System einen Ordner namens CypressAPITests erstellt.

Zypressen-API
2 . Öffnen Sie als Nächstes den Visual Studio Code-Editor und öffnen Sie den in Schritt 1 erstellten Ordner.

3 . Nachdem Sie den Ordner geöffnet haben, besteht der nächste Schritt darin, das Knotenprojekt einzurichten. Verwenden Sie dazu im Terminal den Befehl npm init -y, dadurch wird eine package.json-Datei erstellt.

4 . Wir werden Cypress nun vom Terminal aus installieren, sofern noch nicht geschehen, mit dem Befehl npx cypress install.

5 . Wir erstellen nun die Konfigurationsdateien für unseren Test und führen dazu den Befehl npx cypress open im Terminal aus.

6 . Sobald sich das Cypress-Tool öffnet, wählen Sie E2E-Testing.

7 . Klicken Sie im nächsten Bildschirm auf Weiter.

8 . Sobald die Konfigurationsdateien eingerichtet wurden, kehren Sie zum Visual Studio Code-Editor zurück und Sie werden sehen, dass eine Konfigurationsdatei erstellt wurde.

9 . Jetzt wurde Cypress erfolgreich installiert und auch die Umgebung ist eingerichtet. Wir werden jetzt mit dem Schreiben unserer Tests beginnen.

Wir werden einige Dummy-API-Aufrufe verwenden, um die Cypress API-Automatisierung zu demonstrieren.

Erstellen Sie im Visual Studio Code-Editor einen Ordner e2e im Cypress-Verzeichnis. Unter dem e2e-Ordner können Sie einen weiteren Ordner mit dem Namen APITests erstellen. Beachten Sie, dass Sie den Ordnernamen entsprechend Ihren Anforderungen auswählen können.

Jetzt beginnen wir mit dem Schreiben unserer ersten Testdatei. Wir erstellen eine Datei im Ordner APITests. Nennen wir es HttpGetRequest. Dieser Dateiname hat die Erweiterung .cy.js, wie im Schnappschuss unten gezeigt –

Jetzt beginnen wir mit dem Schreiben des Hauptcodes. Bevor wir das tun, schauen wir uns die grundlegende Syntax der Anfrage an –

cy.request(METHOD,url,body)

In der mit Cypress gestellten Anfrage ist die URL ein obligatorischer Parameter, andere Parameter wie Methode und Text sind jedoch optional. Sie können sich die unterschiedliche Anforderungssyntax aus der offiziellen Dokumentation von Cypress ansehen, um besser zu verstehen, wie wir sie anders verwenden können.

In unserem Beispielszenario verwenden wir die GET-Methode, um einige Ressourcen abzurufen, also verwenden wir die Methode und die URL als Parameter für cy.request.

cy.request('GET','https://dummy.restapiexample.com/api/v1/employees')
Dieser Befehl führt den API-Aufruf an den Server durch.

Als nächstes werden wir einen Antwortwert bestätigen, zum Beispiel den Statuscode.

.its('status')
.should('equal',200);
Diese Codezeile validiert den Antwortstatuscode und stellt sicher, dass sein Wert 200 ist.

Sehen wir uns an, wie dieser Code aussehen wird, wenn er zusammengeführt wird:

describe('HTTPGet',()=>{

it('GET request',()=>{

cy.request('GET','https://dummy.restapiexample.com/api/v1/employees')
.its('status')
.should('equal',200);

})

})
Nachdem wir den Code für eine GET-Anfrage geschrieben haben, führen wir denselben aus. Um es auszuführen, können wir eine der beiden Methoden verwenden:

1. Ausführung über Terminal
2. Ausführung über das Cypress-Tool Wir werden nacheinander sehen, wie wir die Ausführung durchführen können.

Ausführung über Terminal

Um den Cypress-Code über das Terminal auszuführen, öffnen Sie das Terminalfenster und übergeben Sie einfach den folgenden Befehl:

npx cypress run –spec „filepath“

Im obigen Befehl ist der Dateipfad der relative Pfad der Datei, die Sie ausführen möchten. Der folgende Schnappschuss zeigt die Ausführung der HTTPGetRequest-Datei auf meinem System –

Sie können sehen, dass die Testausführung erfolgreich war und unser API-Test bestanden wurde.

Lassen Sie uns nun versuchen, denselben Test mit dem Cypress Tool auszuführen.

Ausführung über Cypress Tool

1 . Schreiben Sie einfach den Befehl npx cypress open, um das Tool zu öffnen.

1. Sobald das Toolfenster geöffnet ist, klicken Sie auf E2E-Tests.

1. Wählen Sie nun einen beliebigen Browser aus. Ich wähle Electron.

1. Sie werden sehen, dass der Electron-Browser geöffnet wird und die Spezifikationen angezeigt werden, die wir für den Visual Studio-Code geschrieben haben.

1. Wählen Sie HttpGetRequest aus und Sie werden sehen, dass die Ausführung mit der Anzeige von Protokollen beginnt.

Und da haben Sie Ihren ersten Cypress API-Automatisierungstest durchgeführt. Wir werden nun unseren Code erweitern, um einige andere HTTP-Methoden auszuführen.

POST-Methode

Code zum Ausführen der POST-HTTP-Anfrage-

describe('HTTPGet',()=>{

it('POST request',()=>{
cy.request({
Methode: 'POST',
URL: 'https://dummy.restapiexample.com/api/v1/create',
Körper: {
„name“: „Testbeitrag“,
„Gehalt“: „1234“,
„Alter“: „23“

}
})
.its('status')
.should('equal',200);
})
})
Nach der Ausführung des obigen Codes zeigen die Protokolle die Ausführungsergebnisse wie unten gezeigt an –

Für unsere nächsten Demonstrationen werden wir eine andere gefälschte API-Sammlung verwenden und sehen, wie die HTTP-Anfragemethoden für sie funktionieren.

PUT-Methode

Code zum Ausführen der PUT-HTTP-Anfrage-

describe('HTTPPut',()=>{

it('PUT request',()=>{
cy.request({
Methode: 'PUT',
URL: 'https://jsonplaceholder.typicode.com/posts/1',
Körper: {
ID: 1,
title: 'Dies ist PUT-Update',
body: 'Dies ist der PUT-Update-Body',
Benutzer-ID: 1,
}
})
.its('status')
.should('equal',200) ;
})
})

Das Ausführungsergebnis des obigen Codes wird unten angezeigt-

DELETE-Methode

Code zum Ausführen der HTTP-Anfrage zum Löschen (Beachten Sie, dass ich den folgenden Codeabschnitt im selben Beispiel angehängt habe, das ich oben verwendet habe)-

it('DELETE request',()=>{
cy.request({
Methode: 'DELETE',
URL: 'https://jsonplaceholder.typicode.com/posts/1',
})
.its('status')
.should('equal',200) ;
})
Da sich sowohl die PUT- als auch die DELETE-Anfrage in derselben Datei befanden, wurden beide Methoden ausgeführt und die Ergebnisse sind wie unten dargestellt –

Das ist es also und Sie wissen jetzt, wie Sie mit Cypress die grundlegenden HTTP-Anfragen für verschiedene Methoden ausführen können. Sie können jetzt versuchen, Cypress API Testing in Ihren Projekten zu implementieren und sehen, wie einfach Sie die APIs mit kurzen Bearbeitungszeiten testen können.

Fazit

Nachdem wir die Grundlagen von API und Cypress für API-Tests durchgegangen sind, kommen wir zu den folgenden Punkten:

1. Cypress API Testing hilft mit einer Reihe leistungsstarker Tools, die eine Vertrautheit mit der Syntax von Cypress für UI-Tests vermitteln.
2. Wir können Assertionen bequem verwenden, um den Antwortstatuscode und alle anderen Antwortparameter zu validieren.

Quelle: Dieser Artikel wurde ursprünglich auf testgrid.io veröffentlicht.

Das obige ist der detaillierte Inhalt vonCypress API-Tests meistern: Ein umfassender Leitfaden mit Beispielen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!