API Connect テスター
API Connect TesterツールはAPIをテストし、テストケースやテストスイートなどを生成する。
このツールは、API Test and Monitor (ATM)ツールがサポートする操作を実行します。 APIが期待通りに機能しているかをテストする。 テスト・アサーションを作成することで、API エンドポイントがさまざまな入力やシナリオに対して正しいレスポンスを表示することを検証することに重点を置く。
- ツールの詳細
- API Testは、 API Managerの API Tests タブからアクセスできます。
- このツールは、
Smart Generation
機能を使用してテストケースを生成します。
テストケースの生成
Generate test case
操作は、提供された API または OpenAPI 仕様ファイルからテスト・スイートを作成する。 APIはドラフトでも、特定のカタログに掲載されたものでもよい。 スイート内の各テストケースは、異なるエンドポイントに対応している。 指定された API または OpenAPI 仕様ファイルに対応するテスト・スイートが存在する場合、そのテスト・スイートは削除され、新しいテスト・スイートが作成されます。 limit および offset パラメータを使用して、リストされるテストケースの数を制御できます。
- カタログ名が指定されていない場合、テスト・スイートは指定された名前のドラフトAPI(利用可能な場合)に対して作成されます。 公開されている API に対してテストケースを生成するには、カタログ名を指定します。
- テスト・スイートが作成された後に API の OpenAPI 仕様が更新された場合、既存のテスト・スイートは削除されなければならない。 更新されたAPI仕様に基づいて、新しいテスト・スイートを作成しなければならない。
パラメーター | 説明 | デフォルト値 | 必須 |
---|---|---|---|
api_name |
テストケースを作成しなければならないAPIの名前。 | なし | オプション |
api_file |
テストケースを実行しなければならないオープン API の仕様名。 | なし | オプション |
catalog |
ユーザーがAPIを公開したカタログ名。 | なし | オプション |
version |
公開されているAPIの特定のバージョン、またはAPIで指定されているバージョン。 | なし | オプション |
limit |
レスポンスに含まれるテストケースの最大数。 整数値を取る。 | 15 | オプション |
Offset |
この数のテストケースをスキップし、残りのテストケースを取得します。 整数値を取る。 | 0 | オプション |
- プロンプトの例
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
- 次のアクション
Run test case for the test suite {testsuite_name}
テストケースの実行
run テスト・ケースは、指定されたテスト・スイートに含まれるテスト・ケース、あるいは API 用に作成されたテスト・ケースを実行します。 実行中にAPIコールが行われ、アサーションが検証される。 APIはドラフトでも、特定のカタログに掲載されたものでもよい。 limit および offset パラメータを使用して、リストされるテストケースの数を制御できます。 この操作は、 テストケースの生成操作の後にのみ実行できます。
パラメーター | 説明 | デフォルト値 |
---|---|---|
api_name |
テストケースを実行しなければならないAPIの名前。 | なし |
api_file |
テストケースを実行しなければならないオープン API の仕様名。 | なし |
test_name |
実行しなければならないテストケースの名前。 | なし |
testsuite_name |
テストケースを実行する必要があるテストスイートの名前。 | なし |
catalog |
ユーザーがAPIで公開したカタログ名。 | なし |
version |
公開されているAPIの特定のバージョン、またはAPIで指定されているバージョン。 | なし |
limit |
レスポンスに表示されるテストケースの最大数。 整数値を取る。 | 15 |
Offset |
この数のテストケースをスキップし、残りのテストケースを取得します。 整数値を取る。 | 0 |
- プロンプトの例
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
- 次のアクション
Get test status for the {api_name} api
Get test status for the test suite {testsuite_name}
API のテスト
Test API オペレーションは、指定された API または OpenAPI 仕様ファイルに対してテストケースを生成し、実行する。 APIはドラフトでも、特定のカタログに掲載されたものでもよい。 limit および offset パラメータを使用して、リストされるテストケースの数を制御できます。
この操作では、これらのテストケースがクリック可能なリンクとして表示され、API Manager のテストケースの Report タブに移動して、テスト結果を確認できます。
パラメーター | 説明 | デフォルト値 |
---|---|---|
api_name |
テストケースを作成して実行する必要があるAPIの名前。 | なし |
api_file |
テストケースを作成・実行するオープンAPI仕様の名前。 | なし |
catalog |
ユーザーがAPIを公開したカタログ名。 | なし |
version |
公開されているAPIの特定のバージョン、またはAPIで指定されているバージョン。 | なし |
limit |
レスポンスに表示されるテストケースの最大数。 整数値を取る。 | 15 |
offset |
この数のテストケースをスキップし、残りのテストケースを取得します。 整数値を取る。 | 0 |
- プロンプトの例
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
- 次のアクション
Get test status for the {api_name} api
Get test status for the test suite {testsuite_name}
テスト・スイートの一覧
list test suite オペレーションは、Provider 組織に存在するすべてのテストスイートのリストを提供します。
- プロンプトの例:
list test suites
テストケース一覧
パラメーター | 説明 | デフォルト値 |
---|---|---|
api_name |
その下で生成されたテストケースを一覧表示するAPI名。 | なし |
catalog |
ユーザーがAPIを公開したカタログ名。 | なし |
testsuite_ name |
テスト・スイートの名前。 | なし |
limit |
レスポンスに表示されるテストケースの最大数。 整数値を取る。 | 15 |
offset |
この数のテストケースをスキップし、残りのテストケースを取得します。 整数値を取る。 | 0 |
- プロンプトの例
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
テスト・スイートの削除
delete test suite
操作は、テスト スイートを、そのテスト スイート内で作成されたすべてのテストケースとともに削除します。パラメーター | 説明 | 必須 |
---|---|---|
testsuite_name |
削除する必要があるテスト・スイートの名前。 | はい |
- プロンプトの例
delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0
テストケースの削除
delete test case
操作は、テスト スイート内の特定のテスト ケースを削除します。パラメーター | 説明 | 必須 |
---|---|---|
test_name |
削除するテストケースの名前。 | はい |
testsuite_name |
削除するテストケースが存在するテストスイートの名前。 | はい |
- プロンプトの例
delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0
テストケースの公開
パラメーター | 説明 | デフォルト値 | 必須 |
---|---|---|---|
test_name |
公開するテストケースの名前。 | なし | はい |
testsuite_name |
公表が必要なテストケースが含まれるテストスイートの名称を示す。 | なし | はい |
- プロンプトの例
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
テストケースのテストステータスを取得する
Get status オペレーションは、指定された API またはテスト・スイートのテスト・ケースの実行ステータスを、ドラフトであるか特定のカタログで公開されているかにかかわらず提供します。 テストケースの数は、リミットとオフセットのパラメーターで制御できる。
Not run
yet
と表示されます。パラメーター | 説明 | デフォルト値 |
---|---|---|
api_name |
テストケースのステータスを取得する必要がある API の名前。 | なし |
test_name |
ステータスを取得する必要があるテストケースの名前。 | なし |
catalog |
ユーザーがAPIを公開したカタログ名。 | なし |
testsuite_ name |
ステータスを取得しなければならないテスト・スイートの名前。 | なし |
limit |
レスポンスに表示されるテストケースの最大数。 整数値を取る。 | 15 |
offset |
この数のテストケースをスキップして、残りのテストケースを取得します。 整数値を取る。 | 0 |
version |
公開されているAPIの特定のバージョン、またはAPIで指定されているバージョン。 | なし |
- プロンプトの例
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 の作成
create webhook
の操作により、特定のテストスイートに対してウェブフックを作成でき、スイートごとに複数のウェブフックを作成できます。 名前、説明、テスト・スイート名を指定してウェブフックを作成できます。 この操作では、作成されたウェブフックの URL と、ウェブフックへのアクセスに必要なキーとシークレットの生成方法のガイドラインが表示されます。- フックへのアクセス
APIフックを使用するには、APIキーとシークレットを生成する必要があります。
APIキーとシークレットを生成するには、以下の手順に従います:- 。
- APIフックとキーを選択します。
- Keys セクションで、 Addをクリックする。
パラメーター | 説明 | デフォルト値 | 必須 |
---|---|---|---|
testsuite_name |
フックを作成しなければならないテスト・スイートの名前。 | なし | はい |
name |
フックはこの名前で作成しなければならない。 | なし | はい |
des_hooks |
フックの説明 | "" | はい |
- プロンプトの例
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
ウェブフック一覧
パラメーター | 説明 | 必須 |
---|---|---|
testsuite_name |
フックをリストしなければならないテスト・スイートの名前。 | はい |
- プロンプトの例
list hooks for test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0
ウェブフックの削除
パラメーター | 説明 | 必須 |
---|---|---|
name |
削除するフックの名前。 | はい |
testsuite_name |
削除するフックが存在するテスト・スイートの名前。 | はい |
- プロンプトの例
delete hook test-hook in test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0