Ein Multi-Step API-Prüfobjekt besteht aus Schritten. Du kannst für jeden Schritt sowohl die HTTP-Abfrage- wie auch -Antwort-Komponenten konfigurieren. Dieser Artikel liefert einen Überblick darüber, wie eine API-Antwort bei einem Multi-Step API-Prüfobjekt funktioniert. Du erfährst, welche HTTP-Antwortdefinitionen verfügbar sind und wie sie eingerichtet werden.
Response
Innerhalb eines Schritts siehst du den Tab Response. Hier kannst du Prüfungen und Validierungen einrichten, um das Verhalten der API-Antwort zu verifizieren.
Assertions
Assertions sind die jeweiligen Bedingungen, die du einrichten kannst, um die API-Antwort zu validieren. Eine Assertion prüft, ob die API die korrekten Daten, Status Codes, Header, Antwortzeit usw. ausgibt
Für jeden Schritt kannst du mehrere Assertions gemäß deinen Monitoring-Anforderungen definieren. Die Definition einer Assertion nutzt die folgenden Komponenten:
Mehr erfährst du unter Multi-Step API Assertions.
Variablen
Bei der Einrichtung von Multi-Step API-Szenarien musst du eventuell bestimmte Daten aus vorherigen Schritten erfassen und an nachfolgende Schritte übergeben. Beispielsweise in Schritt 1 führt deine API eine GET-Abfrage aus, um eine ID abzurufen. In Schritt 2 soll diese ID als ein Abfrageparameter für den API-Abruf verwendet werden.
In solchen Szenarien erlauben dir Variablen, Werte aus HTTP-Antworten zu extrahieren und zu speichern, um sie im gesamten API-Szenario wiederzufinden. Durch Erfassen des Werts, das temporäre Speichern und die Übernahme in den nächsten Schritten erzeugst du eine natürliche Reihe verbundener Schritte, ohne programmieren zu müssen.
Für jeden Schritt kannst du Variablen erstellen. Dies können abgerufene Werte aus JSON- oder XML-Daten, Antwort-Headern oder Daten aus einem
Redirect usw. sein. Nach der Konfiguration kannst du sie als Teil deiner Multi-Step-Einrichtung mit der Syntax {{my-variable}} verwenden.
Mehr erfährst du unter Multi-step API-Variablen.
Maximale Anzahl Versuche
Dies sind Fälle, wenn eine API-Abfrage zusätzlich Zeit benötigt, um den Vorgang abzuschließen, bevor eine Antwort gegeben werden kann. Beispiele sind: Warten auf einen Datei-Upload, eine erfolgreiche Zahlungstransaktion oder Eingang einer E-Mail-Verifizierung. Es gibt auch Fälle, in denen eine API-Abfrage oder eine Assertion aufgrund externer Faktoren fehlschlagen kann, beispielsweise wegen einer schlechten Netzwerkverbindung oder eines unerwarteten Ausfalls. In diesen Situationen kannst du Maximale Anzahl Versuche aktivieren, um automatisch denselben Schritt erneut auszuführen.
Indem derselbe Schritt wiederholt versucht wird, signalisiert dies dem Prüfobjekt, dass der Schritt in einem Wartestadium ist, er noch mal geprüft werden muss und nicht als Fehler erachtet werden sollte. Damit kann auch gemessen werden, wie lang der Hintergrundprozess bis zum Abschluss gebraucht hat.
Du kannst zwischen 2 und 50 Wiederholungsversuche einstellen und eine Verzögerung zwischen jedem Versuch in Millisekunden angeben. Weitere Informationen findest du in dem Artikel Maximale Anzahl Versuche.
Eigene Skripte
Sowohl der Request- als auch Response-Teil eines Schritts können optional anhand von eigenen Skripten auf den Tabs Vor-Anfrage und Nach-Antwort erweitert werden. Damit kannst du Skripte in JavaScript ausführen, um benutzerdefinierte Programme umzusetzen und eingehende Funktionstests abzuwickeln. Neben der vollen Bandbreite, die Standard-JavaScript bietet, kannst du auch Schnipsel einsetzen. Das sind vordefinierte Skripte von Uptrends, um die korrekte Funktionsweise und das Verhalten deiner APIs zu prüfen.