API Connect 测试仪

在线编辑

API Connect Tester 工具可测试应用程序接口，生成测试用例、测试套件等。

该工具可完成 API 测试和监控 (ATM) 工具支持的操作。 它可测试应用程序接口，确保其按预期运行。 它的重点是通过创建测试断言来验证 API 端点是否能针对各种输入和场景显示正确的响应。

工具详细信息
  • 可以在 API 管理器的 "API 测试 "选项卡下访问 API 测试。
  • 该工具使用 Smart Generation 功能生成测试用例。
API Connect Tester 工具支持以下操作：

生成测试用例

Generate test case 操作根据提供的 API 或 OpenAPI 规范文件创建测试套件。 API 可以是草案，也可以在特定目录中发布。 套件中的每个测试用例都对应不同的端点。 如果给定的 API 或 OpenAPI 规范文件存在测试套件，则会删除该套件并创建一个新套件。 您可以使用限制和偏移参数来控制列出的测试用例数量。

此操作将以链接形式显示测试用例列表，引导您访问 API 管理器中的相应测试用例。
注：
  • 如果未指定目录名称，则测试套件将为具有给定名称（如果可用）的 API 草稿创建。 要针对已发布的 API 生成测试用例，请指定目录名称。
  • 如果在创建测试套件后更新了 API 的 OpenAPI 规范，则必须删除现有的测试套件。 必须根据更新后的 API 规范创建新的测试套件。
表 1. 参数
参数 描述 缺省值 必需
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}

运行测试用例

运行测试用例可运行给定测试套件中的测试用例或为 API 创建的测试用例。 在运行过程中，会调用 API 并验证断言。 API 可以是草案，也可以在特定目录中发布。 您可以使用限制和偏移参数来控制列出的测试用例数量。 此操作只能在 " 生成测试用例 "操作之后执行。

在此操作过程中，每个测试用例都要验证服务器 URL 是否有效，以便进行 API 调用。 如果缺少服务器 URL （如在 API 草案中），测试用例将无法运行。 通过测试用例的可点击链接，提示用户在编辑器中更新服务器 URL。 如果测试用例有一个有效的服务器 URL ，就会有一个链接指向 API 管理器中测试用例的 " 报告 "选项卡，您可以在那里查看测试结果。
表 2. 参数
参数 描述 缺省值
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

测试 API 操作会生成测试用例，并针对给定的 API 或 OpenAPI 规范文件运行这些测试用例。 API 可以是草案，也可以在特定目录中发布。 您可以使用限制和偏移参数来控制列出的测试用例数量。

该操作会将这些测试用例显示为可点击链接，引导您进入 API 管理器中的测试用例报告选项卡，在那里您可以查看测试结果。

表 3. 参数
参数 描述 缺省值
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 suites

列出测试用例

列表测试用例操作可显示给定测试套件或 API 的测试用例列表。 API 可以是草案，也可以在特定目录中发布。 您可以使用限制和偏移参数来控制列出的测试用例数量。
表 4. 参数
参数 描述 缺省值
api_name 要列出在该 API 下生成的测试用例的 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 操作会删除测试套件以及在该测试套件中创建的所有测试用例。
表 5. 参数
参数 描述 必需
testsuite_name 需要删除的测试套件名称。 是
示例提示
delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0

删除测试用例

delete test case 操作删除测试套件中的特定测试用例。
表 6. 参数
参数 描述 必需
test_name 应删除的测试用例名称。 是
testsuite_name 要删除的测试用例所在的测试套件名称。 是
示例提示
delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0

发布测试用例

配置并验证测试后，就可以发布测试了。 如果提供了测试套件名称，该操作将发布套件中的特定测试用例；如果没有指定测试套件名称，则将发布套件中的所有测试用例。
表 7. 参数
参数 描述 缺省值 必需
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

获取测试用例的测试状态

获取状态 "操作可提供指定 API 或测试套件的测试用例执行状态，无论其是草案还是在特定目录中发布。 测试用例的数量可通过限制和偏移参数来控制。

该操作提供了测试状态和个案状态的综合摘要。 对于每个已执行的测试用例，它都会显示成功和失败的断言计数，以及指向 API 管理器中测试用例报告选项卡的链接。 如果测试用例尚未运行，则该测试用例的状态显示为 Not run yet 。
表 8. 参数
参数 描述 缺省值
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 密钥和秘密，请完成以下步骤：
  1. 转到测试套件 > 设置。
  2. 选择 API 钩子和密钥。
  3. 在密钥部分，单击添加。
表 9. 参数
参数 描述 缺省值 必需
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

列出网络钩子

此操作会列出为特定测试套件创建的所有网络钩子。
表 10. 参数
参数 描述 必需
testsuite_name 必须列出钩子的测试套件名称。 是
示例提示
list hooks for test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0

删除网络钩子

此操作将从指定的测试套件中删除带有给定名称的特定 webhook。
表 11. 参数
参数 描述 必需
name 需要删除的钩子名称。 是
testsuite_name 要删除钩子的测试套件名称。 是
示例提示
delete hook test-hook in test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0