So senden Sie eine Anforderung an die REST-Web-API

Anforderungstyp

Der REST-Web-API-Test unterstützt verschiedene HTTP-Methoden, die entsprechend Ihren Testzielen verwendet werden können. Wenn Sie eine GET-Anforderung auswählen, werden einfach Daten aus Ihrer Web-API abgerufen. Obwohl Anforderungsparameter in der URL enthalten sein können, wird empfohlen, dedizierte Methoden zu verwenden, um die Nutzlast an eine API zu übertragen.

Verwenden Sie Anforderungstypen wie POST, PUT oder PATCH, um benutzerdefinierte Informationen zu senden, Daten zu ändern oder Einen Flow oder ein Ereignis auszulösen. Navigieren Sie in diesem Fall zum Abschnitt Daten buchen, um den Anforderungstext anzugeben.

Wenn Sie den Anforderungstyp auf POST, PUT oder PATCH festlegen, aber die Anforderungsparameter im Abschnitt “Daten buchen” nicht angeben, wird der Anforderungstyp beim Speichern der Aufgabe wieder in GET geändert.

Authentifizierung

Wenn Ihre API eine Authentifizierung erfordert, geben Sie die Anmeldeinformationen im Abschnitt “Standardauthentifizierung” an. Wenn die tokenbasierte Authentifizierung die verwendete Methode ist, befolgen Sie die Empfehlungen für OAuth 2.0-basierte APIs, und konfigurieren Sie Authentifizierungsparameter auf ähnliche Weise.

Post-Daten

In diesem Abschnitt können Sie ganz einfach alle Anforderungsentitäten bereitstellen, z. B. JSON.

Um den Anforderungstext anzugeben, fügen Sie einfach JSON-Inhalt ein oder geben Sie ihn in das Feld ein. Das System analysiert den Code automatisch, und Sie werden aufgefordert, einen Inhaltstypheader basierend auf dem Anforderungstexttyp auszuwählen. Außerdem können Sie bei Bedarf einen benutzerdefinierten Inhaltstypheader bereitstellen.

Nach der Angabe wird der Inhaltstyp automatisch zum Abschnitt Headers hinzugefügt.

Erstellen einer Auflistung von Anforderungen

Sie können beweitete Anforderungen innerhalb eines Tests senden, wie Sie möchten. Beachten Sie, dass alle Anforderungen dem Test in der Reihenfolge hinzugefügt werden müssen, in der sie ausgeführt werden müssen.

So richten Sie einen Test mit mehreren Anfordern ein:

  1. Erstellen und speichern Sie zunächst einen neuen Rest Web-API-Test.
  2. Um eine Abfolge von Anforderungen innerhalb des Tests einzurichten, wählen Sie in der Liste der Tests im Aktionsmenü des Tests die Option Ziel hinzufügen

    aus.
  3. Richten Sie die Anforderungseinstellungen ein, und speichern Sie Änderungen. Die Anforderungen werden in der Seitenleiste des Bearbeitungsbildschirms des Geräts in der Reihenfolge aufgeführt, in der sie ausgeführt werden. Um auf die Anforderungsparameter zuzugreifen, wählen Sie das entsprechende Element in der Seitenleiste aus.
  4. Um die nächste Anforderung in der Bearbeitungsoberfläche des Geräts hinzuzufügen, klicken Sie auf die Schaltfläche “Plus” in der Seitenleiste.

Weitere Informationen zur Konfiguration und Überwachung von Geräten mit mehreren Zielen finden Sie unter Hinzufügen mehrerer Ziele innerhalb eines einzelnen Geräts.

Ergebnisvalidierung

Im Allgemeinen reicht es nicht aus, einfach einen Aufruf einer API zu tätigen, mit dem Ziel, sicherzustellen, dass die API-Antwort Daten enthält, die erwartet wurden. Um die API-Antwort zu überprüfen, reicht es aus, einige Schlüsselwörter zu finden, die genau in der Antwort übereinstimmen. Wenn Sie Ihren API-Antwortinhalt kennen, können Sie die Schlüsselwörter im Abschnitt Inhaltsvalidierung bereitstellen. Weitere Informationen finden Sie im Artikel “Schlüsselwort”.

Anwendungsfälle

Betrachten wir eine E-Mail-REST-API als Beispiel. Um den Dienst zu überwachen, müssen wir die POST-Anforderung zusammen mit den E-Mail-Details im Anforderungstext an den entsprechenden API-Endpunkt senden. Dazu müssen wir die Endpunkt-URL angeben und den POST-Anforderungstyp auswählen.

Da die E-Mail-REST-API eine Standardauthentifizierung erfordert, müssen wir auch die Anmeldeinformationen im entsprechenden Abschnitt angeben.

Im Abschnitt “Daten nach” geben wir das JSON-Array mit E-Mail-Details an und wählen den Headertyp aus, um die Nutzlast an den API-Endpunkt zu übertragen.

Der nächste Schritt besteht darin, ein Schlüsselwort anzugeben, nach dem in der API-Antwort für die Validierung gesucht werden soll.

  • REST-API-Überwachung

    Die meisten modernen Webanwendungen verwenden eine REST-API, um mit dem Server zu kommunizieren und sich untereinander zu integrieren. Um die korrekte Qualität der Daten in der API zu gewährleisten, stellen wir die Qualität des gesamten Webdienstes sicher, der sie verwendet.

    Angenommen, Sie haben eine RESTful-API für Ihren Webdienst erstellt, und es muss gesteuert werden, dass alle API-Funktionen ordnungsgemäß funktionieren und rund um die Uhr verfügbar sind. Aber warum müssen wir eine WEB-API testen, ist es nicht einfacher, eine Benutzeroberfläche auf Probleme zu testen? Lassen Sie uns die häufigsten Vorteile von API-Tests und -Überwachungen erläutern.

    Der erste Vorteil von REST-API-Tests besteht darin, dass es hilft, eine bestimmte Ursache eines Problems zu identifizieren. Durch das Testen Ihrer API können Sie herausfinden, welche bestimmte Funktion mit Fehlern ausgeführt wird.

    Außerdem müssen Sie bei API-Tests keine dedizierte Testumgebung erstellen, um Ihre Webdienstfunktionalität zu testen. Im Gegensatz zu UI-Tests, die eine Kette von Benutzeraktionen in einem Browserfenster erfordern, um eine Anforderung an einen Webserver zu senden, können API-Tests und -Überwachung mithilfe automatisierter Tools zum Senden einer bestimmten Endpunktanforderung durchgeführt werden. Mit diesem Ansatz können Sie z. B. ein Problem umgehen, da auf GUI-Ebene falsche Testfehler auftreten.

    Obwohl Sie alle API-Funktionen manuell testen können, ist dies ein schwieriger und zeitaufwändiger Prozess. Darüber hinaus müssen die Tests jedes Mal, wenn Sie Änderungen vornehmen oder neue Features an Ihrer API hinzugefügt haben, erneut ausgeführt werden, um sicherzustellen, dass sich die Aktualisierungen nicht auf die API-Funktionalität ausgewirkt haben. Die automatisierte REST-API-Überwachung ermöglicht es, die Nachteile manueller Tests zu vermeiden und Ihre API-Überwachungsroutine auf die nächste Stufe zu bringen.

    REST API Monitoring mit Dotcom-Monitor

    Dotcom-Monitor bietet zwei Optionen für die automatisierte API-Leistungsüberwachung:

    • Das REST-Web-API-Überwachungsgerät.
    • Das Überwachungsgerät Postman Collection.

    Um den RESTful API Monitoring Test von Grund auf neu einzurichten, wird empfohlen, unser REST Web API Monitoring-Gerät zu verwenden. Mit diesem Typ des Überwachungsgeräts können Sie eine einfache HTTP-Anforderung an einen API-Endpunkt mit einer Standardauthentifizierung und POST-Parametern konfigurieren.

    Falls Sie Postman bereits zum Ausführen der Tests Ihrer RESTful API-Dienste verwendet haben, wird empfohlen, Ihre Postman Collection in Dotcom-Monitor zu importieren. Nachdem die Sammlung von Postman-Anforderungen in das System importiert wurde, können Sie das Überwachungsgerät Postman Collection so konfigurieren, dass die Überwachung Ihrer API-Dienste automatisiert wird.

    Obwohl das REST-Web-API-Gerät die Ausführung von mehreren Anfragen unterstützt, kann es in einigen Fällen schwierig sein, sie zu konfigurieren. Wenn Sie mit dem Tool vertraut sind, eignet sich Postman beispielsweise hervorragend, um parametrisierte HTTP-Anforderungen und Assertionstests für die REST-Web-API-Überwachung zu konfigurieren.

    Wenn Sie also einen Test mit einer komplizierten Abfolge von API-Aufrufen erstellen möchten oder wenn eine andere Authentifizierung als die Standardauthentifizierung erforderlich ist, verwenden Sie Postman, um eine Auflistung von API-Aufrufen zu erstellen. Importieren Sie es dann einfach in das Dotcom-Monitor Postman Collection-Gerät und richten Sie die Überwachung ein, wie in der Postman Monitoring (Collection Tasks) mit Dotcom-Monitor-APIsbeschrieben. Dotcom-Monitor führt API-Aufrufe mit einer angegebenen Häufigkeit (bis zu 1 min) aus, generiert Berichte und sendet Überwachungsfehlerbenachrichtigungen an eine angegebene Adresse.

    Schauen Sie sich unsere komplette Suite von API-Überwachungstools bei Dotcom-Monitor an, um die Zuverlässigkeit von Webanwendungen und -diensten zu gewährleisten!