API Connect Tester

The API Connect Tester tool tests APIs generates test cases, test suites, and more.

The tool completes operations that are supported by the API Test and Monitor (ATM) tool. It tests APIs to ensure that they are functioning as expected. It focuses on verifying that the API endpoints display the correct responses for various inputs and scenarios, by creating test assertions.

Tool details

The API Test can be accessed under the API Tests tab in the API Manager.
This tool uses the Smart Generation feature to generate test cases.

The following operations are supported in the API Connect Tester tool:

Generate test cases
Run test cases
Test API
List test suites
List test cases
Delete test suites
Delete test cases
Publish test cases
Get test status for test cases
Create webhooks
List webhooks
Delete webhooks

Generate test cases

The Generate test case operation creates a test suite from the provided API or OpenAPI specification file. The API can be either a draft or published in a specific catalog. Each test case in the suite corresponds to a different endpoint. If a test suite exists for the given API or OpenAPI specification file, it is deleted and a new one gets created. You can control the number of test cases that are listed by using the limit and offset parameters.

This operation displays a list of test cases as links, directing you to the corresponding test cases in the API Manager.

Note:

If the catalog name is not specified, the test suite is created for a draft API with the given name (if available). To generate test cases against a published API, specify the catalog name.
If the OpenAPI specification of an API is updated after a test suite has been created, the existing test suite must be deleted. A new test suite must be created based on the updated API specification.

Table 1. Parameters
Parameter	Description	Default value	Required
`api_name`	The name of the API for which test cases must be created.	None	Optional
`api_file`	The name of the open API specification for which the test case must be run.	None	Optional
`catalog`	The catalog name that the user published the API in.	None	Optional
`version`	The specific version of the API that has been published or the version that is specified in the API.	None	Optional
`limit`	Maximum number of test cases, which is in the response. Takes an integer value.	15	Optional
`Offset`	Skip this number of test cases and retrieves the remaining test cases. Takes an integer value.	0	Optional

Example prompts

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
```

Suggested next action

Run test case for the test suite {testsuite_name}

Run test cases

The run test case runs the test cases in the given test suite or created for an API. During run, API calls are made, and the assertions are validated. The API can be a draft or published in a specific catalog. You can control the number of test cases that are listed by using the limit and offset parameters. This operation can only be performed after the Generate test case operation.

During this operation, each test case is verified for a valid server URL to make API calls. If the server URL is missing, as in draft APIs, the test case will not run. The user is prompted to update the server URL in the editor through a clickable link to the test case. If the test case has a valid server URL, a link directs you to the Report tab of the test cases in the API Manager, where you can review the test results.

Table 2. Parameters
Parameter	Description	Default value
`api_name`	Name of the API for which test cases must be run.	None
`api_file`	The name of the open API specification for which the test case must be run.	None
`test_name`	Name of the test case, which must be run.	None
`testsuite_name`	Name of the testsuite for which test cases must be run.	None
`catalog`	The catalog name that the user published on the API.	None
`version`	The specific version of the API that has been published or the version that is specified in the API.	None
`limit`	Maximum number of test cases, which is shown in the response. Takes an integer value.	15
`Offset`	Skip this number of test cases and retrieves the remaining test cases. Takes an integer value.	0

Example prompts

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

Suggested next action

Get test status for the {api_name} api

Get test status for the test suite {testsuite_name}

Test API

The Test API operation generates test cases and runs them for the given API or OpenAPI specification file. The API can either be a draft or published in a specific catalog. You can control the number of test cases that are listed by using the limit and offset parameters.

The operation presents these test cases as clickable links, directing you to the Report tab of the test cases in the API Manager, where you can review the test results.

Table 3. Parameters
Parameter	Description	Default value
`api_name`	Name of the API for which test cases must be created and run.	None
`api_file`	Name of the open api specification for which test case has to be created and run.	None
`catalog`	The catalog name in which the user published the API in.	None
`version`	The specific version of the API that has been published or the version that is specified in the API.	None
`limit`	Maximum number of test cases, which will be shown in the response. Takes an integer value.	15
`offset`	Skip this number of test cases and retrieves the remaining test cases. Takes an integer value.	0

Example prompts

```
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
```

Suggested next action

Get test status for the {api_name} api

 Get test status for the test suite {testsuite_name}

List test suites

The list test suite operation provides a list of all test suites present in the Provider organization.

Example prompt:

list test suites

List test cases

The list test cases operation displays the list of test cases present for the given test suite or API. The API can be either a draft or published in a specific catalog. You can control the number of test cases that are listed by using the limit and offset parameters.

Table 4. Parameters
Parameter	Description	Default value
`api_name`	Name of the API name to list the test cases generated under it.	None
`catalog`	The catalog name in which the user published the API in.	None
`testsuite_ name`	Name of the test suite to list the test cases inside it.	None
`limit`	Maximum number of test cases, which will be shown in the response. Takes an integer value.	15
`offset`	Skip this number of test cases and retrieves the remaining test cases. Takes an integer value.	0

Example prompts

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

The delete test suite operation deletes a test suite, along with all the test cases created within that test suite.

Table 5. Parameters
Parameter	Description	Required
`testsuite_name`	Name of the test suite which needs to be deleted.	Yes

Example prompt

delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0

Delete test case

The delete test case operation deletes a specific test case within a test suite.

Table 6. Parameters
Parameter	Description	Required
`test_name`	Name of the test case that should be deleted.	Yes
`testsuite_name`	The name of the test suite in which the test case to be deleted is present.	Yes

Example prompt

delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0

Publish test cases

After configuring and verifying your test, you can publish it. This operation publishes a specific test case within a test suite if a name is provided, or all test cases in the suite if no test suite name is specified.

Table 7. Parameters
Parameter	Description	Default value	Required
`test_name`	Name of the test case that should be published.	None	Yes
`testsuite_name`	The name of the test suite in which the test case that needs to be published are is presented.	None	Yes

Example prompts

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 test status for test cases

The Get status operation furnishes the execution status of test cases for the specified API or test suite, whether it's a draft or published in a specific catalog. The number of test cases can be controlled through the limit and offset parameters.

This operation provides a consolidated summary of test status and individual case status. For each executed test case that has run, it displays successful and failed assertion counts, along with a link to the Report tab of the test cases in the API Manager. If a test case has not been run, its status is displayed as

Not run
yet

for the particular test case.

Table 8. Parameters
Parameter	Description	Default value
`api_name`	The name of the API for which the status of test cases must be fetched.	None
`test_name`	Name of the test case for which status must be fetched.	None
`catalog`	The catalog name in which the user published the API.	None
`testsuite_ name`	Name of the test suite for which status must be fetched.	None
`limit`	The maximum number of test cases, which will be shown in the response. Takes an integer value.	15
`offset`	Skip this number of test cases and retrieve the remaining test cases. Takes an integer value.	0
`version`	The specific version of the API that has been published or the version that is specified in the API.	None

Example prompts

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

Create webhook

The create webhook operation enables the creation of a webhook for a specific test suite, allowing creation of multiple webhooks per suite. You can create webhooks by providing a name, description, and the test suite name. The operation shows the URL of the created webhook, along with guidelines on how to generate the key and secret required to access the webhook.

Accessing the hook

To use the API hook, you are required to generate an API key and secret.

To generate an API key and secret, complete the following steps:

Go to test suite > Settings.
Select API hooks and keys.
In the Keys section, click Add.

Table 9. Parameters
Parameter	Description	Default value	Required
`testsuite_name`	Name of the test suite for which the hook must be created.	None	Yes
`name`	Hook must be created with this name.	None	Yes
`des_hooks`	Description for the hook.	""	Yes

Example prompts

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

List webhooks

This operation lists all the webhooks that are created for a particular test suite.

Table 10. Parameters
Parameter	Description	Required
`testsuite_name`	The name of the test suite for which the hook must be listed.	Yes

Example prompt

list hooks for test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0

Delete webhooks

This operation deletes a specific webhook with the given name from the specified test suite.

Table 11. Parameters
Parameter	Description	Required
`name`	Name of the hook that needs to be deleted.	Yes
`testsuite_name`	The name of the test suite in which the hook to be deleted is present.	Yes

Example prompt

delete hook test-hook in test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0