Updated on 2026-01-09 GMT+08:00

Creating an Automated API Test Suite

Prerequisites

API automation test cases have been created.

Procedure

  1. Log in to the CodeArts homepage, search for your target project, and click the project name to access the project.
  2. In the navigation pane, choose Testing > Testing Execution.
  3. Click the drop-down icon next to Test case library and select a test plan.
  4. On the Auto API Test tab page, click Create Suite in the upper left corner. The creation page is displayed.
  5. Enter basic information such as the name, click Add Case or Add Now, and select the test case to be executed.

    To search for a test case, enter the name, ID, description, or custom fields in the search box.

  6. Complete the execution settings as required and click Save.

    Configuration Item

    Mandatory

    Description

    Agent Pool

    Yes

    By default, the default agent pool is selected.

    ID

    No

    Enter 1 to 128 characters.

    Tag

    No

    Set tags for the current task as required. Tags are separated by spaces. Each task can be associated with a maximum of 10 tags.

    Module

    No

    Module of the current test suite. The module list comes from the project settings.

    Processor

    No

    Person who needs to complete the test task.

    Environment Parameters

    No

    Environment parameters can be referenced by parameters, checkpoints, variables, and URLs of test steps in the entire project.

    Max. Duration

    Yes

    The longest time taken for executing a test case. Cases exceeding this limit will fail. The task continues until the last case is complete.

    Overwrite Test Suite Parameters

    No

    You can set advanced parameters for a test suite, and overwrite global parameters in a test suite. A maximum of three global parameters can be overwritten.

    Execute

    Yes

    There are two types. By default, the task is executed only once.

    • Once: The test suite is executed only once.
    • Regularly: After you set an execution frequency, the test suite is executed periodically. Set this parameter to daily.

    Start

    Yes

    There are two execution modes. By default, the task is executed immediately.

    • Immediately: The task is executed immediately after it is executed.
    • At specific time: The task is executed after a specified time.

    Sequence

    Yes

    There are two modes. The default mode is Serial.

    • Serial: Test cases in the API test suite are executed in serial mode.
    • Parallel: Test cases in the API test suite are executed in parallel mode.