Add validations or extract values from API responses

Learn how to validate API calls for accurate and reliable tests.

Low Code Automation allows you to make API calls while recording your test, solving the complexity of automating test cases that involve dependencies beyond the web application UI. You can integrate API calls directly into tests for:

• Initializing test environments
• Invoking specific services
• Checking backend conditions
• Managing test data

Add API step

To add API requests in your tests, click the ︙ icon in the recorder panel and select Add API to configure an API step.

You will see a response window to fill in the request details like API URL, Parameters, Authorization, Header, and Body.

Request data

Low Code Automation supports both JSON and XML response types for API steps.

Import existing variable

Import an existing variable or link it to a test dataset variable. Click the + icon and select Local variables or Test dataset variables. You can import a variable or test dataset variable into any API field, such as URL, Username, Key, Value, and more.

Validate or extract response details

After you fill in the request fields and click send, the request is executed and a response is populated. The response contains:

• Status
• Response headers
• Response body (JSON or XML)

You can then validate and extract values from both JSON and XML responses.

Validate JSON response

1. Expand the response section to add validations on status, headers, or body.
2. Hover over any value, and you will see the Validate option appear.
3. Click Validate to add validation on the respective field.
4. You can add multiple validations in a single API step.

Extract value from JSON response

Click the Extract value option to store any response status, header, or body value from a JSON response into a variable. You can use this variable in later steps of your test. For example:

{
  "user": {
    "id": 12345,
    "name": "Jane Doe"
  }
}

If you want to extract the user ID, set the JSON path to $.user.id. The extracted value (for example, 12345) is stored in a variable, which you can reference in subsequent test steps.

Validate XML response

1. Expand the response section to add validations on status, headers, or body.
2. Hover over any XML node or attribute, and you will see the Validate option appear.
3. Click Validate to add validation using XPath expressions for the selected XML element.
4. You can add multiple validations in a single API step.

Extract value from XML response

Click the Extract value option to store any XML node or attribute value into a variable. Use XPath to select the value you want to extract. This variable can then be imported in any future steps. For example:

<user>
  <id>12345</id>
  <name>Jane Doe</name>
</user>

If you want to extract the user ID, set the XPath to /user/id. The extracted value (e.g., 12345) is stored in a variable, which you can reference in later test steps.

API step execution

After test execution, a new See Details button appears, showing details about the API execution call.

Click this button to view the request, the generated response (JSON or XML), along with the extracted variable values or validation results. If multiple validations were added, you will see results for all the passed and failed validations. For XML, the validation results display the XPath used and the value checked.