Wenn du noch nicht vertraut mit Multi-Step APIs bist, empfehlen wir die Artikel Multi-Step API Monitoring und Multi-Step API Response, um einen Überblick über die Kernfunktionen und wichtigsten Merkmale zu erhalten.
Dieser Artikel bietet Informationen dazu, wie maximale Anzahl Versuche funktioniert und wie damit API-Antworten verifiziert sowie erwartetes Verhalten der API sichergestellt werden kann.
Maximale Anzahl Versuche
Es gibt Situationen, in denen eine API-Abfrage zusätzlich Zeit benötigt, um den Vorgang abzuschließen, bevor eine Antwort gegeben werden kann. Beim Upload einer Datei antwortet die API beispielsweise zunächst möglicherweise mit {"result":"processing"} im JSON Body, um anzuzeigen, dass der Vorgang noch im Verlauf ist. Sobald die Verarbeitung abgeschlossen ist, gibt die API {"result":"success"} aus. In Szenarien wie diesen kannst du das Prüfobjekt anweisen, die API aufzurufen, bis eine success-Antwort gegeben wird.
Es kann auch Fälle geben, in denen deine APIs sich unerwartet verhalten, aufgrund unvorhergesehener Umstände oder externer Probleme wie Ausfälle oder Verbindungsschwierigkeiten. Diese Situationen werden nicht als Fehler erachtet. Eine Wiederholung des Schritts kann das Problem eventuell einfach lösen.
Die Maximale Anzahl Versuche erlaubt dem Prüfobjekt, den Schritt weiter in regulären Intervallen auszuführen, bis das gewünschte Ergebnis erreicht wurde oder die maximale Versuchszahl erschöpft ist. Aktivieren dieser Option weist das Prüfobjekt an, den Schritt erneut zu versuchen, wenn eine oder mehrere Assertions fehlschlagen. Du kannst maximal 50 Wiederholungsversuche einstellen, mindestens aber zwei, da die ursprüngliche Abfrage bereits als erster Versuch zählt.
Du kannst auch eine Wartezeit zwischen Versuchen konfigurieren, um die Verzögerung zwischen zwei Versuchen zu steuern. Diese muss zwischen 500 ms und 30.000 ms liegen, mit einer Standarddauer von 1.000 ms.
Wenn du die Option für einen Schritt aktiviert hast, wird das Prüfobjekt den Schritt so lange versuchen, bis entweder die maximale Anzahl Versuche erreicht oder die Assertion bestätigt wurde. Dann werden das Prüfobjekt und die Schritte in ihrer Reihenfolge wie gewöhnlich weiter ausgeführt. Wenn die angegebene Anzahl Versuche erreicht ist und eine Assertion immer noch nicht bestätigt wurde, verzeichnet das Prüfobjekt einen Fehler im Prüfobjektprotokoll.