Introduction

The API Step feature addresses the challenge of automating test cases with dependencies beyond the webapp UI. This functionality allows users to incorporate API calls within a test to interact with the backend, enabling testing scenarios such as

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

API Step Components

Click on the “︙” icon from the recorder panel and select option “Add API” to configure an API.

Request Component:

• Method: Select the HTTP method for the API call (GET, POST, PUT, DELETE, PATCH)
• URL: Specify the URL for the API endpoint.
• Parameters: Use key-value fields for query parameters.
• Authorization: Choose and use the appropriate authorization method (Basic, Bearer).
• Header: Set headers(cookie, content-type, encoding, language, etc) as per your API requirements
• Body: Send data in any of the below format
  • Form data or key-value fields
  • Raw

Response Component:

Once 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

You can validate any of the above three. Expand the sections and hover over any of the values under them to validate. In the response body, you can use valid JSON expressions to extract a particular key value and validate it.