API Connect Tester

Das Tool API Connect Tester testet APIs und generiert Testfälle, Testsuiten und mehr.

Das Tool führt Vorgänge aus, die vom Tool API Test and Monitor (ATM) unterstützt werden. Es testet APIs, um sicherzustellen, dass sie wie erwartet funktionieren. Der Schwerpunkt liegt auf der Überprüfung, ob die API-Endpunkte die richtigen Antworten für verschiedene Eingaben und Szenarien anzeigen, indem Testaussagen erstellt werden.

Tooldetails
  • Der API-Test kann über die Registerkarte API-Tests im API-Manager aufgerufen werden.
  • Dieses Tool verwendet die Funktion Smart Generation , um Testfälle zu erzeugen.
Die folgenden Operationen werden vom API Connect Tester unterstützt:

Testfälle generieren

Die Operation Generate test case erstellt eine Testsuite aus der bereitgestellten API- oder OpenAPI Spezifikationsdatei. Die API kann entweder ein Entwurf sein oder in einem bestimmten Katalog veröffentlicht werden. Jeder Testfall in der Suite entspricht einem anderen Endpunkt. Wenn eine Testsuite für die angegebene API oder OpenAPI Spezifikationsdatei existiert, wird sie gelöscht und eine neue erstellt. Sie können die Anzahl der aufgelisteten Testfälle mit den Parametern Limit und Offset steuern.

Dieser Vorgang zeigt eine Liste von Testfällen als Links an, die Sie zu den entsprechenden Testfällen im API Manager führen.
Hinweis:
  • Wenn der Katalogname nicht angegeben wird, wird die Testsuite für einen API-Entwurf mit dem angegebenen Namen erstellt (falls vorhanden). Um Testfälle für eine veröffentlichte API zu erstellen, geben Sie den Katalognamen an.
  • Wenn die OpenAPI Spezifikation einer API aktualisiert wird, nachdem eine Testsuite erstellt wurde, muss die bestehende Testsuite gelöscht werden. Eine neue Testsuite muss auf der Grundlage der aktualisierten API-Spezifikation erstellt werden.
Tabelle 1. Parameter
Parameter Beschreibung Standardwert Erforderlich
api_name Der Name der API, für die Testfälle erstellt werden müssen. Keine Optionale
api_file Der Name der offenen API-Spezifikation, für die der Testfall ausgeführt werden muss. Keine Optionale
catalog Der Katalogname, in dem der Benutzer die API veröffentlicht hat. Keine Optionale
version Die spezifische Version der API, die veröffentlicht wurde, oder die Version, die in der API angegeben ist. Keine Optionale
limit Maximale Anzahl von Testfällen, die in der Antwort enthalten sind. Nimmt einen ganzzahligen Wert an. 15. Optionale
Offset Überspringen Sie diese Anzahl von Testfällen und rufen Sie die restlichen Testfälle ab. Nimmt einen ganzzahligen Wert an. 0 Optionale
Beispielhafte Aufforderungen
  • Generate test case for Swagger-Petstore api
  • Generate test case for Swagger-Petstore api in sandbox
  • Generate test for Swagger-Petstore:1.0.0 api
  • Generate test for Swagger-Petstore api with version 1.0.0 in sandbox
  • Generate test case for Swagger-Petstore api with limit 5 offset 15
  • Generate test case for @bookshop.yaml
Vorgeschlagene nächste Maßnahme
Run test case for the test suite {testsuite_name}

Testfälle ausführen

Der Testfall run führt die Testfälle der angegebenen Testsuite oder die für eine API erstellten Testfälle aus. Während der Ausführung werden API-Aufrufe getätigt und die Behauptungen validiert. Die API kann ein Entwurf sein oder in einem bestimmten Katalog veröffentlicht werden. Sie können die Anzahl der aufgelisteten Testfälle mit den Parametern Limit und Offset steuern. Dieser Vorgang kann nur nach dem Vorgang Testfall generieren durchgeführt werden.

Während dieses Vorgangs wird jeder Testfall auf einen gültigen Server URL überprüft, um API-Aufrufe zu tätigen. Wenn der Server URL fehlt, wie bei API-Entwürfen, wird der Testfall nicht ausgeführt. Der Benutzer wird aufgefordert, den Server URL im Editor über einen anklickbaren Link zum Testfall zu aktualisieren. Wenn der Testfall einen gültigen Server URL hat, werden Sie über einen Link zur Registerkarte Bericht der Testfälle im API-Manager geleitet, wo Sie die Testergebnisse überprüfen können.
Tabelle 2. Parameter
Parameter Beschreibung Standardwert
api_name Name der API, für die Testfälle ausgeführt werden müssen. Keine
api_file Der Name der offenen API-Spezifikation, für die der Testfall ausgeführt werden muss. Keine
test_name Name des Testfalls, der ausgeführt werden muss. Keine
testsuite_name Name der Testsuite, für die Testfälle ausgeführt werden müssen. Keine
catalog Der Katalogname, den der Benutzer in der API veröffentlicht hat. Keine
version Die spezifische Version der API, die veröffentlicht wurde, oder die Version, die in der API angegeben ist. Keine
limit Maximale Anzahl von Testfällen, die in der Antwort angezeigt wird. Nimmt einen ganzzahligen Wert an. 15.
Offset Überspringen Sie diese Anzahl von Testfällen und rufen Sie die restlichen Testfälle ab. Nimmt einen ganzzahligen Wert an. 0
Beispielhafte Aufforderungen
  • run test for AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • run test for Swagger-Petstore api
  • run test for Swagger-Petstore api in sandbox
  • run test for Swagger-Petstore:1.0.0 api
  • run test for Swagger-Petstore api with version 1.0.0 in sandbox
  • run test for AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • run test for AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger-Petstore-1.0.0 test suite
  • run test for Swagger-Petstore api with limit 5 offset 15
Vorgeschlagene nächste Maßnahme
Get test status for the {api_name} api
Get test status for the test suite {testsuite_name}

API testen

Die Operation Test API generiert Testfälle und führt sie für die angegebene API oder OpenAPI Spezifikationsdatei aus. Die API kann entweder ein Entwurf sein oder in einem bestimmten Katalog veröffentlicht werden. Sie können die Anzahl der aufgelisteten Testfälle mit den Parametern Limit und Offset steuern.

Die Operation stellt diese Testfälle als anklickbare Links dar, die Sie zur Registerkarte Bericht der Testfälle im API-Manager führen, wo Sie die Testergebnisse überprüfen können.

Tabelle 3. Parameter
Parameter Beschreibung Standardwert
api_name Name der API, für die Testfälle erstellt und ausgeführt werden müssen. Keine
api_file Name der offenen Api-Spezifikation, für die ein Testfall erstellt und ausgeführt werden soll. Keine
catalog Der Katalogname, in dem der Benutzer die API veröffentlicht hat. Keine
version Die spezifische Version der API, die veröffentlicht wurde, oder die Version, die in der API angegeben ist. Keine
limit Maximale Anzahl der Testfälle, die in der Antwort angezeigt werden sollen. Nimmt einen ganzzahligen Wert an. 15.
offset Überspringen Sie diese Anzahl von Testfällen und rufen Sie die restlichen Testfälle ab. Nimmt einen ganzzahligen Wert an. 0
Beispielhafte Aufforderungen
  • test api Swagger-Petstore api
  • test api Swagger-Petstore api in sandbox
  • test api Swagger-Petstore:1.0.0 api
  • test api Swagger-Petstore api with version 1.0.0 in sandbox
  • test api for Swagger-Petstore api with limit 5 offset 15
  • test api for @bookshop.yaml
Vorgeschlagene nächste Maßnahme
Get test status for the {api_name} api
 Get test status for the test suite {testsuite_name}

Testsuiten auflisten

Die Operation Testsuite auflisten liefert eine Liste aller in der Anbieterorganisation vorhandenen Testsuiten.

Beispiel für eine Aufforderung:
list test suites

Testfälle auflisten

Die Operation Testfälle auflisten zeigt die Liste der Testfälle an, die für die angegebene Testsuite oder API vorhanden sind. Die API kann entweder ein Entwurf sein oder in einem bestimmten Katalog veröffentlicht werden. Sie können die Anzahl der aufgelisteten Testfälle mit den Parametern Limit und Offset steuern.
Tabelle 4. Parameter
Parameter Beschreibung Standardwert
api_name Name des API-Namens zur Auflistung der darunter generierten Testfälle. Keine
catalog Der Katalogname, in dem der Benutzer die API veröffentlicht hat. Keine
testsuite_ name Name der Testsuite, um die darin enthaltenen Testfälle aufzulisten. Keine
limit Maximale Anzahl der Testfälle, die in der Antwort angezeigt werden sollen. Nimmt einen ganzzahligen Wert an. 15.
offset Überspringen Sie diese Anzahl von Testfällen und rufen Sie die restlichen Testfälle ab. Nimmt einen ganzzahligen Wert an. 0
Beispielhafte Aufforderungen
  • list test cases in AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • list test cases in Swagger-Petstore api
  • list test cases in Swagger-Petstore api in sandbox
  • list test cases in Swagger-Petstore api with limit 5 offset 15

Testsuite löschen

Die Operation delete test suite löscht eine Testsuite zusammen mit allen in dieser Testsuite erstellten Testfällen.
Tabelle 5. Parameter
Parameter Beschreibung Erforderlich
testsuite_name Name der Testsuite, die gelöscht werden soll. Ja
Beispiel für eine Aufforderung
delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0

Testfall löschen

Die Operation delete test case löscht einen bestimmten Testfall innerhalb einer Testsuite.
Tabelle 6. Parameter
Parameter Beschreibung Erforderlich
test_name Name des Testfalls, der gelöscht werden soll. Ja
testsuite_name Der Name der Testsuite, in der sich der zu löschende Testfall befindet. Ja
Beispiel für eine Aufforderung
delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0

Testfälle veröffentlichen

Nachdem Sie Ihren Test konfiguriert und verifiziert haben, können Sie ihn veröffentlichen. Dieser Vorgang veröffentlicht einen bestimmten Testfall innerhalb einer Testsuite, wenn ein Name angegeben wurde, oder alle Testfälle in der Suite, wenn kein Name für die Testsuite angegeben wurde.
Tabelle 7. Parameter
Parameter Beschreibung Standardwert Erforderlich
test_name Name des Testfalls, der veröffentlicht werden soll. Keine Ja
testsuite_name Hier wird der Name der Testsuite angegeben, in der der zu veröffentlichende Testfall enthalten ist. Keine Ja
Beispielhafte Aufforderungen
  • publish test in test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • publish test AA_TEST_CASE_get/200 in test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0

Teststatus für Testfälle abrufen

Der Vorgang Status abrufen liefert den Ausführungsstatus von Testfällen für die angegebene API oder Testsuite, unabhängig davon, ob es sich um einen Entwurf handelt oder ob er in einem bestimmten Katalog veröffentlicht wurde. Die Anzahl der Testfälle kann über die Parameter Limit und Offset gesteuert werden.

Dieser Vorgang liefert eine konsolidierte Zusammenfassung des Teststatus und des Status der einzelnen Fälle. Für jeden ausgeführten Testfall wird die Anzahl der erfolgreichen und fehlgeschlagenen Assertions angezeigt, zusammen mit einem Link zur Registerkarte Bericht der Testfälle im API-Manager. Wenn ein Testfall noch nicht ausgeführt wurde, wird sein Status als Not run yet für den jeweiligen Testfall angezeigt.
Tabelle 8. Parameter
Parameter Beschreibung Standardwert
api_name Der Name der API, für die der Status der Testfälle abgerufen werden muss. Keine
test_name Name des Testfalls, für den der Status abgerufen werden muss. Keine
catalog Der Katalogname, in dem der Benutzer die API veröffentlicht hat. Keine
testsuite_ name Name der Testsuite, für die der Status abgerufen werden muss. Keine
limit Die maximale Anzahl der Testfälle, die in der Antwort angezeigt werden. Nimmt einen ganzzahligen Wert an. 15.
offset Überspringen Sie diese Anzahl von Testfällen und rufen Sie die restlichen Testfälle ab. Nimmt einen ganzzahligen Wert an. 0
version Die spezifische Version der API, die veröffentlicht wurde, oder die Version, die in der API angegeben ist. Keine
Beispielhafte Aufforderungen
  • get test status for Swagger-Petstore api
  • get test status for Swagger-Petstore api in sandbox
  • get test status for Swagger-Petstore:1.0.0 api
  • get test status for Swagger-Petstore api with version 1.0.0 in sandbox
  • get test status for test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0
  • get test status for AA_TEST_CASE_get/200 in test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0

Webhook erstellen

Die Operation create webhook ermöglicht die Erstellung eines Webhooks für eine bestimmte Testsuite, wobei mehrere Webhooks pro Suite erstellt werden können. Sie können Webhooks erstellen, indem Sie einen Namen, eine Beschreibung und den Namen der Testsuite angeben. Der Vorgang zeigt die URL des erstellten Webhooks an, zusammen mit einer Anleitung, wie man den Schlüssel und das Geheimnis generiert, die für den Zugriff auf den Webhook erforderlich sind.
Zugriff auf den Haken

Um den API-Hook zu nutzen, müssen Sie einen API-Schlüssel und ein Geheimnis generieren.

Führen Sie die folgenden Schritte aus, um einen API-Schlüssel und ein Geheimnis zu generieren:
  1. Gehen Sie zu Testsuite > Einstellungen.
  2. Wählen Sie API-Hooks und Schlüssel.
  3. Klicken Sie im Abschnitt " Schlüssel" auf Hinzufügen.
Tabelle 9. Parameter
Parameter Beschreibung Standardwert Erforderlich
testsuite_name Name der Testsuite, für die der Hook erstellt werden muss. Keine Ja
name Hook muss mit diesem Namen erstellt werden. Keine Ja
des_hooks Beschreibung für den Haken. "" Ja
Beispielhafte Aufforderungen
  • create hook with name test-hook for test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0
  • create hook with name test-hook with description 'For testing purpose' for the test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0

Webhaken auflisten

Dieser Vorgang listet alle Webhooks auf, die für eine bestimmte Testsuite erstellt wurden.
Tabelle 10. Parameter
Parameter Beschreibung Erforderlich
testsuite_name Der Name der Testsuite, für die der Hook aufgelistet werden muss. Ja
Beispiel für eine Aufforderung
list hooks for test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0

Webhooks löschen

Diese Operation löscht einen bestimmten Webhook mit dem angegebenen Namen aus der angegebenen Testsuite.
Tabelle 11. Parameter
Parameter Beschreibung Erforderlich
name Name des Hooks, der gelöscht werden soll. Ja
testsuite_name Der Name der Testsuite, in der der zu löschende Haken vorhanden ist. Ja
Beispiel für eine Aufforderung
delete hook test-hook in test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0