Request step

Request is the main building block of tests. It represents a single API call or a user action.

Request sections

When we expand the request editor by clicking at the top-right of the request, we can see that a test request includes two main sections - Request and Response Handling sections.

The Request Handling section

The Method and URL fields are the most basic requirements for a valid request.
Black input fields are fields in which you can use parameters and functions.
It is recommended to set the Request description in a way that describes its action. This will make it easier for you to debug your tests later if this request fails.
Some requests require a body. Selecting the right content-type for your request will help us highlight the syntax of your request body (i.e. JSON or XML).
The Headers section allows to see and set the request headers. You can add header to all requests or as a Global Header so that it will be added to all of the test flow requests and appear in the Global Login tab.

GraphQL requests

A standard GraphQL POST request should use the application/json content type, and include a JSON-encoded body of the following form:

{
    "query": "...",
    "operationName": "...",
    "variables": {
        "var1": "value",
    }
}

operationName and variables are optional fields. operationName is only required if multiple operations are present in the query.

The response should return the queried data in a JSON. i.e.,

{
  "data": { ... },
  "errors": [ ... ]
}

Based on (graphql.org).

The Response Handling section

The response handling section includes 3 sections: Extractions - Set Parameters, Postscript - run code (disabled by default), Assertions - Verify Response and Flow control.

The Extractions - Set Parameters section allows you:

To extract values from the response body into an existing or a new parameter using JSONPath, Closure, jQuery, RegExp.
To extract an HTTP header value into a parameter using the Header extractor.
To assign a static value or apply a function on another parameter using the "Assign" option.
To add an extraction from the Suggestions repository. Team admins configure the repository within Settings - Suggestions.