HTTP Client#

Steps for making HTTP requests and validating responses

Request Setup#

Step	Description
`"api" header "Content-Type" is "application/json"`	Set a header
`"api" headers are:`	Set multiple headers from table
`"api" query param "page" is "1"`	Set a query parameter
`"api" body is:`	Set raw request body (docstring)
`"api" json body is:`	Set JSON body + Content-Type header
`"api" form body is:`	Set form-encoded body from table

Step	Description
`"api" sends "GET" to "/users"`	Send HTTP request
`"api" sends "POST" to "/users" with body:`	Send with raw body
`"api" sends "POST" to "/users" with json:`	Send with JSON body

Step	Description
`"api" response status is "200"`	Assert exact status code
`"api" response status is success`	Assert status class (2xx, 3xx, 4xx, 5xx)

Step	Description
`"api" response header "Content-Type" is "application/json"`	Assert exact header value
`"api" response header "Content-Type" contains "json"`	Assert header contains substring
`"api" response header "X-Request-Id" exists`	Assert header exists

Step	Description
`"api" response body is:`	Assert exact body match
`"api" response body contains "success"`	Assert body contains substring
`"api" response body does not contain "error"`	Assert body doesn't contain substring
`"api" response body is empty`	Assert empty body

Step	Description
`"api" response json "data.id" is "123"`	Assert JSON path value
`"api" response json "data.id" exists`	Assert JSON path exists
`"api" response json "data.deleted" does not exist`	Assert JSON path doesn't exist
`"api" response json matches:`	Assert exact JSON structure with matchers: @string, @number, @boolean, @array, @object, @any, @null, @notnull, @empty, @notempty, @regex:pattern, @contains:text, @startswith:text, @endswith:text, @gt:n, @gte:n, @lt:n, @lte:n, @len:n
`"api" response json contains:`	Assert JSON contains specified fields (ignores extra fields). Supports same matchers as 'matches'
`"api" response json "id" matches pattern "^[0-9a-f-]{36}$"`	Assert JSON path value matches regex pattern
`"api" response json "id" is uuid`	Assert JSON path value is a valid UUID
`"api" response json "email" is email`	Assert JSON path value is a valid email format
`"api" response json "created_at" is iso-timestamp`	Assert JSON path value is an ISO 8601 timestamp

Step	Description
`"api" response time is less than "500ms"`	Assert response time

Step	Description
`"api" response json "id" saved as "{{user_id}}"`	Save JSON path value to variable for use in subsequent requests
`"api" response header "Location" saved as "{{location}}"`	Save response header value to variable