Write an after-response script to test a response in Insomnia

Uses: Insomnia

Prerequisites

Insomnia

Download and install Insomnia.

Create and configure an API Collection

For this tutorial, you’ll need an API Collection in Insomnia. An API Collection is essential for this tutorial to function, but creating one isn’t the focus of this guide. Use the following to add a pre-configured API Collection to Insomnia:

This pre-configured API Collection contains:

The example “Flights Service 0.1.0” OpenAPI spec in its Spec tab
Requests generated from the spec
Pre-configured base environment variables

Add an after-response script

In this example, we’ll configure an after-response script that checks the value of a JSON field in a response:

In Insomnia, navigate to the “Flight Service 0.1.0” API Collection.
Click the Collection tab in the sidebar.
In the sidebar of your collection, select the Get KongAir planned flights request.
Open Scripts > After-response.
In the bottom pane, click Response Handling > Get body as JSON. This will add code that creates a jsonBody variable that we can use to check the content of the response body.
Add the following content after the variable:
```
insomnia.test('Check the first route ID', () => {
 insomnia.expect(jsonBody[0].route_id).to.eql('LHR-JFK');
 });
```
Copied!
In this example, insomnia.test() creates a new test, and insomnia.expect() creates an assertion on the value of the route_id field in the first object of the array returned by the request.

Validate the after-response script

Now that we created an after-response script, we can validate it by sending a GET request to the /flights/ endpoint.

Click Send. You should get a 200 status code with a JSON array as the response. Go to the Tests tab in the right pane to check that the test passed.