Für die ersten Schritte in Bezug auf Assertions (Prüfpunkte) empfehlen wir, den Artikel zur Multi-Step API-Antwort zu lesen, um einen Überblick der Kernfunktionen und wichtigen Merkmale zu erhalten.
Dieser Artikel erläutert, wie Assertions funktionieren und wie sie dir helfen, API-Antworten zu verifizieren und erwartetes Verhalten der API sicherzustellen.
Assertions
Innerhalb eines Schritts findest du den Tab Response, auf dem du Assertions konfigurieren kannst.
Assertions sind Bedingungen, mit denen du deine API-Antworten prüfen kannst. Du kannst sie verwenden, um festzustellen, ob die API-Abfrage erfolgreich war, einen bestimmten Inhalt in der Antwort aufweist oder ein unerwartetes Verhalten auftritt. Du kannst ganz einfach mehrere Validierungen definieren, um zu prüfen, dass deine API korrekt antwortet und die erwarteten Daten liefert.
Im Beispiel unten prüft eine Assertion, ob der Wert des Produktpreises größer als 100 ist. Assertions werden anhand vier Feldern definiert: Quelle, Merkmal, Vergleich und Zielwert.
Jedes Feld entspricht einem bestimmten Wert, um festzustellen, wie die Antwort bewertet werden sollte. Die Funktion dieser Felder kann sich abhängig von der Antwortprüfung unterscheiden.
Unten siehst du die Assertionfelder, die du gemäß deinen Monitoring-Anforderungen definieren kannst.
Assertion-Quelle
Bei diesem Feld bestimmst du den Ursprung bzw. die Datenquelle, die du überprüfen möchtest. Dies könnte Response Body als JSON, Response Body als Text oder ein Attribut aus einer HTTP-Antwort wie etwa der Status Code und vieles mehr sein. Weitere Informationen findest du unter
Assertion-Quellen.
Assertion-Merkmal
Einige
Assertions-Quellen wie Response Body als JSON oder Response Header erfordern, dass du einen bestimmten Inhaltsabgleich vornimmst, um die Antwort weiter zu validieren. Wenn du bestimmte Daten aus der Antwort prüfen möchtest, musst du den genauen Merkmalswert, der dem Assertion-Quelltyp entspricht, angeben. Im Beispiel oben ist Products[0].Price der Merkmalswert.
Assertion-Vergleich
Dieses Feld dient zur Auswahl des Vergleichsoperators, der verwendet wird, um die Beziehung zum Assertion-Zielwert evaluieren. Standardmäßig ist Ist identisch mit eingestellt, aber du kannst andere
Vergleichsoptionen gemäß deinen Anforderungen auswählen.
Assertion-Zielwert
Nehmen wir an, du möchtest den aus der API-Antwort abgerufen Produktpreis mit einem besonderen Wert, zum Beispiel 10, vergleichen. In diesem Fall ist 10 der Assertion-Zielwert, mit dem du vergleichen solltest.
Das Feld ermöglicht dir, einen Wert als Basis zum Vergleich zu definieren. Abhängig von der ausgewählten Assertion-Quelle, dem -Merkmal und Vergleichstyp kann dieser Wert Text, eine Nummer oder ein Boolescher Operator sein. Du kannst auch eine Variablen-Referenz verwenden, die einen dieser Werttypen repräsentiert.
Was passiert, wenn eine Assertion-Bedingung nicht erfüllt wurde?
Alle Assertions in einem Schritt werden ausgeführt, sobald die HTTP-Abfrage abgeschlossen ist und die Antwort verarbeitet wurde. Jede Assertion wird regelhaft einzeln bewertet, selbst wenn eine vorherige Assertion fehlgeschlagen ist. Im Ergebnis ist es möglich, dass dies mehrere fehlgeschlagene Assertions für einen einzelnen Schritt berichtet.
Wenn eine Assertion fehlschlägt, stoppt das Prüfobjekt sofort seine Ausführung. Jeder nachfolgende Schritt wird übersprungen und das Prüfobjekt berichtet einen Fehler. Der Fehlercode und die Beschreibung hängen von der Art des Ausfalls ab. Wenn mehrere Assertions einen Fehler zurückgeben, wird der erste Fehler von der Liste als wichtigster erachtet. Wenn du möchtest, dass das Prüfobjekt weiter alle Schritte ausführt, auch wenn ein Fehler auftritt, lies den Artikel Fehlerbehandlung bei Multi-Step APIs.
In einigen Fällen kann es notwendig sein, zum Beispiel, eine Assertion noch mal zu probieren, wenn ein Zeitproblem fälschlicherweise einen Fehler melden könnte. Du kannst einstellen, dass die Assertion mehrere Male bewertet wird. Weitere Informationen findest du in dem Artikel zur Aktivierung der maximalen Anzahl Versuche.