Assertions
API-Prüfung Assertions
Was sind Assertions?
Assertions sind Bedingungen, die Sie festlegen, um den Statuscode und die Antwortzeit Ihrer API-Anfrage zu validieren. Sie helfen sicherzustellen, dass sich Ihre API unter verschiedenen Bedingungen wie erwartet verhält. Wenn eine oder mehrere Assertions fehlschlagen, wird eine Warnung ausgelöst, die es Ihnen ermöglicht, sofort zu handeln.
Arten von Assertions
Sie können folgende Arten von Assertions für Ihre API-Prüfungen festlegen:
- Antwortzeit: Legen Sie einen Wert fest und prüfen Sie dagegen. Wenn die Antwortzeit den angegebenen Wert überschreitet, schlägt die Assertion fehl, was zum Fehlschlagen des Tests führt.
- Statuscode: Geben Sie den erwarteten Statuscode der API-Antwort an. Wenn der Antwortcode vom erwarteten Wert abweicht, schlägt die Assertion fehl, was zum Fehlschlagen der API-Prüfung führt.
Fehlgeschlagene Assertions und Prüfungsdetails
Wenn eine Assertion fehlschlägt, werden die Details des Fehlers auf der Prüfungsdetailseite sichtbar. Dies umfasst Informationen darüber, welche Assertion fehlgeschlagen ist und warum, was Ihnen hilft, Probleme schnell zu identifizieren und zu beheben.
Zusammenspiel mit Antwortzeit-Limits
Wenn eine Prüfung ein Antwortzeit-Limit hat und als verschlechtert markiert ist, aber auch eine fehlschlagende Assertion hat, wird die Prüfung als fehlgeschlagen markiert. Dies stellt sicher, dass alle kritischen Probleme umgehend erfasst und behoben werden.
So legen Sie Assertions fest
- Assertions-Einstellungen aufrufen: Navigieren Sie zu den Assertions-Einstellungen für Ihre API-Prüfung.
- Assertions hinzufügen: Geben Sie den Typ der Assertion an, die Sie hinzufügen möchten (Antwortzeit, Statuscode).
- Kriterien festlegen: Definieren Sie die Kriterien für die Assertion (z. B. erwarteter Statuscode, maximale Antwortzeit).
- Einstellungen speichern: Stellen Sie sicher, dass Sie Ihre Einstellungen speichern, um die Assertions anzuwenden.
Praktische Anwendungsfälle
- Leistungsüberwachung: Verwenden Sie Antwortzeit-Assertions, um sicherzustellen, dass Ihre API die Leistungsbenchmarks erfüllt.
- Fehlererkennung: Verwenden Sie Statuscode-Assertions, um unerwartete Fehler oder Ausfälle in Ihrer API zu erkennen.
Durch die Verwendung von Assertions können Sie sicherstellen, dass Ihre APIs wie erwartet funktionieren und die richtigen Daten liefern, was zur Aufrechterhaltung der Zuverlässigkeit und Leistung Ihrer Dienste beiträgt.