Save API Response Data

Effectively manage and analyse API response data within our test case management tool. Capture essential details like response status, response code, and response body for in-depth analysis and validation.

In this section you'll learn how to save the various response data to validate the API response.

Save API Response

• To save the entire API response, locate the 'Save' option in the response section and select 'Save Response' to save the entire API response payload.

• Assign the extracted value to a parameter for later use. You can also create a new parameter of type runtime and assign.

• After storing the API response, you can custom validate the response key and value, JSON Array and JSON Object using custom methods.

Save JSON Key

• Effectively handle dynamic JSON keys within API responses by using "Save JSON Key".

• Determine the JSON key that appears dynamically within the API response and select the "Save JSON Key" option.

• Specify the JSON path to the desired key using a valid JSONPath expression. Assign the extracted value to a parameter for later use. You can also create a new parameter of type runtime and assign.

Example:

JSON Response

In below example JSON key to save email which occurs dynamically in the response would be

JSON Path: response.data[1].email

{
"page"📑: 2,
"per_page"📑: 6,
"total"📑: 12,
"total_pages"📑: 2,
"data"📑: [
{
"id"📑: 7,
"email"📑: "[email protected]",
"first_name"📑: "Michael",
"last_name"📑: "Lawson",
"avatar"📑: https://reqres.in/img/faces/7-image.jpg
},
{
"id"📑: 8,
"email"📑: "[email protected]",
"first_name"📑: "Lindsay",
"last_name"📑: "Ferguson",
"avatar"📑: https://reqres.in/img/faces/8-image.jpg
},
],
"support"📑: {
"url"📑: https://reqres.in/#support-heading,
"text"📑: "To keep ReqRes free, contributions towards server costs are appreciated!"
}
}

Save Response Status Code, Size and Time

When you run a API request in the API Editor, API response should contain response status code, size and time.

To save this response data and validate in the same test case or some other test case, click on the respective response and assign the extracted value to a parameter for later use. You can also create a new parameter of type runtime and assign.