Day 11: Handling Timeouts and Error Responses

In Rest Assured, handling timeouts and error responses is crucial for building robust and reliable API test suites. Timeouts help control the maximum time allowed for a request to complete, while error responses provide valuable information about the failure scenarios encountered during API interactions. Let's delve into more detail about handling timeouts and error responses using Rest Assured.

1. Handling Timeouts:

Timeouts are used to define the maximum time to wait for a response from an API endpoint. It is essential to set appropriate timeouts to prevent excessive waiting or hanging of test cases. Rest Assured provides options to configure timeouts for different stages of an HTTP request, such as connection timeouts and read timeouts. Here's how you can handle timeouts:

Connection Timeout:

The connection timeout is the maximum time allowed for establishing a connection with the server. You can set the connection timeout using the RestAssured.config() method as follows:

       
      RestAssured.config = RestAssured.config().connectionConfig(
        ConnectionConfig.connectionConfig().timeout(5000)
);

         

In the above code, we set the connection timeout to 5000 milliseconds (5 seconds). Adjust the timeout value based on the requirements of your API.

Read Timeout:

The read timeout is the maximum time allowed for receiving the response from the server after the connection has been established. You can set the read timeout using the RestAssured.config() method as follows:

        
       
       RestAssured.config = RestAssured.config().httpClient(
        HttpClientConfig.httpClientConfig().setParam("http.connection.timeout", 5000)
                .setParam("http.socket.timeout", 5000)
);
         

In the above code, we set both the connection and socket timeouts to 5000 milliseconds (5 seconds). Adjust the timeout values based on your specific needs.

2. Handling Error Responses:

Error responses provide valuable information about failures encountered during API interactions. Rest Assured allows you to handle error responses and extract meaningful details for further analysis or reporting. When an error response is received, Rest Assured throws an exception, providing access to the response status code, response body, and other relevant information.
To handle error responses, you can use assertions to verify the expected status code or extract error details from the response body. For example:

        
       Response response = RestAssured.get("https://api.example.com/users/123");
int statusCode = response.getStatusCode();

if (statusCode == 200) {
    // Process successful response
} else {
    String responseBody = response.getBody().asString();
    // Extract and handle error details from the response body
    // Report or perform appropriate actions based on the error scenario
}
         

In the above code, we send a GET request to an API endpoint and retrieve the status code using getStatusCode(). If the status code indicates success (200), we can process the successful response. Otherwise, we extract the response body as a string and handle the error details.

By effectively handling timeouts, you can control the maximum wait time for API responses and prevent test cases from hanging indefinitely. Additionally, handling error responses allows you to extract and analyze important information when API interactions encounter failures. These practices contribute to building reliable and resilient API test suites using Rest Assured.

Previous Next