Mehrstufige API-Prüfungen
Was eine mehrstufige API-Prüfung ist
Eine mehrstufige API-Prüfung führt eine geordnete Folge von HTTP-Anfragen als eine einzige Prüfung aus und gibt dabei Daten aus früheren Antworten an spätere Anfragen weiter. Anstatt einen Endpunkt isoliert zu überwachen, können Sie einen echten Arbeitsablauf nachbilden — zum Beispiel sich anmelden, ein Authentifizierungs-Token erfassen, dann einen authentifizierten Endpunkt aufrufen und dessen Antwort prüfen.
Dies ist der richtige Prüfungstyp, wann immer eine einzelne Anfrage nicht beweisen kann, dass Ihre API tatsächlich durchgängig funktioniert:
- Authentifizieren, ein Token extrahieren und damit einen geschützten Endpunkt aufrufen.
- Eine Ressource erstellen, ihre
iderfassen und sie dann lesen oder löschen. - Eine Suchanfrage in eine Detailanfrage verketten.
- Eine kurze Benutzerreise über mehrere Endpunkte der Reihe nach durchlaufen.
Eine mehrstufige API-Prüfung erstellen
- Öffnen Sie die Seite für neue API-Prüfung.
- Wählen Sie den Prüfungstyp Multistep API.
- Geben Sie der Prüfung einen benutzerfreundlichen Namen (wird in Warnungen und Berichten verwendet).
- Fügen Sie Ihre Schritte in der Reihenfolge hinzu, in der sie ausgeführt werden sollen.
Für die gemeinsamen Einstellungen — Häufigkeit, Standorte, Benachrichtigungskanäle, Aktivieren/Stummschalten — siehe So erstellen Sie eine neue API-Prüfung; eine mehrstufige Prüfung verwendet dieselben Optionen.
Geordnete Schritte hinzufügen
Jeder Schritt ist seine eigene HTTP-Anfrage mit:
- Einer HTTP-Methode (GET, POST, PUT, PATCH, DELETE).
- Einer URL.
- Headern.
- Einem Anfrage-Body.
- Einer oder mehreren Assertions.
Die Schritte werden der Reihe nach, von oben nach unten ausgeführt. Der erste Schritt läuft, dann der zweite und so weiter. Sie können die Schritte neu anordnen, wenn sich Ihr Arbeitsablauf ändert.
Daten zwischen Schritten weitergeben
Die Stärke einer mehrstufigen Prüfung liegt darin, Daten aus einer Antwort in die nächste Anfrage zu übernehmen.
Einen Wert aus der Antwort eines Schritts extrahieren
Fügen Sie in einem Schritt eine Extraktionsregel hinzu, die einen Wert aus Folgendem zieht:
- Dem Antwort-Body (zum Beispiel ein JSON-Feld wie das Access-Token).
- Einem Antwort-Header (zum Beispiel ein
Location- oderSet-Cookie-Wert). - Dem Antwort-Status.
Speichern Sie den extrahierten Wert in einer benannten Variable.
Die Variable in einem späteren Schritt referenzieren
Verwenden Sie einen {{variable}}-Platzhalter an beliebiger Stelle in der URL, den Headern oder dem Body eines späteren Schritts. Zur Laufzeit ersetzt LoadFocus den erfassten Wert.
Erfassen Sie beispielsweise ein Token aus Schritt 1 in einer Variable namens token und senden Sie es dann in Schritt 2:
Authorization: Bearer {{token}}
Variablen werden in der Reihenfolge der Schritte aufgelöst, sodass ein Schritt nur Werte verwenden kann, die frühere Schritte bereits extrahiert haben.
Assertions und Bestanden/Fehlgeschlagen
Jeder Schritt hat seine eigenen Assertions (Statuscode, Body, Header, Antwortzeit), genau wie eine einzelne API-Prüfung. Die Schritte werden zu einem aggregierten Ergebnis kombiniert:
- Wenn jeder Schritt besteht, besteht die Prüfung.
- Wenn ein Schritt fehlschlägt, stoppt die Kette bei diesem Schritt und die gesamte Prüfung wird als fehlgeschlagen markiert — spätere Schritte werden nicht ausgeführt.
Dieses Fail-Fast-Verhalten spiegelt einen echten Arbeitsablauf wider: Wenn die Anmeldung fehlschlägt, ist es sinnlos, den authentifizierten Endpunkt aufzurufen.
Ergebnisse pro Schritt im Bericht
Der Prüfungsbericht zeigt Ergebnisse pro Schritt, sodass Sie genau sehen können, wo eine Sequenz abgebrochen ist: die Methode und URL jedes Schritts, dessen Antwortzeit, welche Assertions bestanden oder fehlgeschlagen sind und wo die Kette gestoppt hat. So lässt sich leicht feststellen, ob ein Fehler bei der Authentifizierung, im nachgelagerten Aufruf oder in einer Assertion lag.
Alle Ihre Prüfungen finden Sie auf der API-Monitore-Seite.