Creating API Tests

API tests verify that API module configurations behave as expected. Use the Testing Tool to create, run, edit, and delete API tests. After configuration, tests run automatically whenever the module is saved.

What Is an API Test?

The following test types are available:

Create API Tests for Multiple Modules

If an application involves multiple API modules, set up API tests to ensure all those API calls work correctly. The Testing tool supports bulk creation of Execution Sequence and Match Response API tests across all API modules. These tests verify that responses are accurate and firing sequences are correct.

To create API tests for multiple modules:

1. Open the Testing tool.

2. Click Create Bulk API Tests.

The Bulk API Test Creator dashboard displays test options, filters, and a table of all environment API modules. By default, the table only displays API modules without tests, making it easier to find API modules that need tests.

Bulk API Test Creator

By default, the test name is Created by Bulk Test Creator. Click the Test Name field to rename it. The Execution Sequence test is selected by default in API Test Types to Create and is recommended for all API modules. Deselect it to use Match Response instead, or select both.

By default, every API module in the Selected Modules for Test Creation table uses the selected tests. To run tests on specific modules, use the filters.

After filtering, matching modules populate the Selected Modules for Test Creation table. Tests only run on modules in this table. The table displays 10 modules by default; use the pagination at the bottom to see more.

Creating an API Test

If API modules have service logs, the tests run on the most recent one.

To create a test:

1. In the Test Name field, enter a test name, or keep the default value.

2. From the API Test Types to Create options, select one or both of the tests.

3. Use the dashboard's filters to display only the relevant API modules.

4. At the top right of the page, click Create Tests.

   

5. Click OK to confirm running the tests on the selected modules.

6. Click OK in the dialog to return to the Bulk API Test Creator.

If an API module has service logs, a checkmark displays in the Test Status column. If no service logs exist, the Test Status displays No Log Found. Return to the module and execute it to generate service logs, then create the test.

Create API Tests for a Single Module

To create one or more API tests for a single module:

1. Open the Testing tool.

2. Click Create Single API Test.

3. From the Module drop-down, select an API module.

To view the module in the Module Builder, click the View Module in Designer link.

Selecting Recent Service Log API Request Data

If the module has recent service logs, these details populate automatically:

• The most recent service log timestamp (Recent Service Logs).

• The service log ID (Service Log ID).

• The log's API request (Request).

• The log's API response (Response).

To view a different service log, select it from the Recent Service Logs drop-down. Then click View Service Logs Dashboard for more details.

Manually Entering API Request Data

If no service logs exist, the API request must be entered manually.

After selecting a module to test:

1. Set Enter JSON Manually as the Request / Response Data.

   This is the default setting if no service logs exist for this module.

2. In the Request field, enter the API request JSON.

3. Below the Request field, click GET Response. API response data displays in the Response field.

Creating an API Test

1. At the bottom of the page, click Add Test.

2. In the Test Name field, enter a unique test name.

3. Select a Test Type.

Using the Validate Fields Test Type

Under Test Types, Validate Fields requires additional information. After selecting Validate Fields, the following options display:

To set up a Validate Fields test:

1. In the Test Name field, enter a unique test name.

2. Select a Test Type.

3. In the Data Field, enter a specific data field.

   Examples of data fields include key and array.0.key.

4. Select a Validation Type.

   When Size is selected:

   1. From the Condition drop-down, select a condition.

   2. In the Size field, enter the size of the array.

   When Value is selected:

   1. From the Condition drop-down, select a condition.

   2. In the Value field, enter the response value for the data field.

   

5. Click + Add.

   Repeat these steps to add more validations.

6. Click Save.

The test page displays. New tests appear at the bottom. Click Create Test to run them, or they run automatically when the module is saved.