Help Center/ CodeArts TestPlan/ User Guide/ Configuring a Test Case/ Creating an Automated API Test Case/ Using Automated API Test Cases
Updated on 2024-11-13 GMT+08:00
View PDF
Share

Using Automated API Test Cases

A rich UI is provided for writing of automated API test cases. You can orchestrate test steps in a visual manner, use various checkpoints, configure extraction as needed, and quickly generate test cases that match the core API logic without coding. You can also arrange API test sequence by dragging and dropping test steps, so as to generate your own strategies for automated testing. With CodeArts TestPlan, testers can generate automated API test scripts based on scenarios, free from repeated work, and immersing in exploratory testing and other more creative and high-value testing activities.

An automated API test case consists of basic information and scripts.

  • Basic information is for managing and describing the test case, including the name (mandatory), type, module, version, sprint, associated requirements, ID, tag, test case level, processor, folder, description, prerequisites, test steps, and expected results.
  • A script defines automated test procedure, including test steps, logic control, and test parameters.

The process of using an automated API test case consists of three stages: preparation, testing, and destruction.

The preparation stage corresponds to the Pre-steps tab page to prepare for the test prerequisites. The testing stage corresponds to the Test Procedure tab page to implement the API function test. The destruction stage corresponds to the Post-steps tab page to release or restore the test data in the preparation and testing stages.

  • (Optional) Preparation stage
    • In this stage, prepare the prerequisite data required in the testing stage. If there is no prerequisite, skip this stage.
    • In this stage, the prerequisites are initialized using API calls. If the data of the prerequisites needs to be referenced in the testing stage, you can use parameter passing to parameterize the data. For details, see Setting the Response Extraction of an API Script.
  • Testing stage

    Define the API core test steps. The test steps in the testing stage can reference the parameters extracted in the preparation stage.

  • (Optional) Destruction stage
    • To avoid affecting other tests or the next test, you are advised to clear the test environment data, restore the initial status of the test environment, and destroy the data created in the preparation stage after each test.
    • If no data needs to be destroyed, ignore this stage. You can destroy data using API calls. The test steps in the destruction stage can reference the parameters extracted in the preparation stage.