How to Test POST JSON Object Requests Using Java Map in Rest Assured

In the world of API testing, Rest Assured is a popular Java library that simplifies the process of testing RESTful services. One common use case is sending POST requests with JSON payloads. In this blog post, we’ll explore how to test POST requests using a Java Map to create JSON objects, providing a clear and efficient way to handle your request data.

What is Rest Assured?

Rest Assured is a powerful Java library for testing REST APIs. It allows you to write tests in a way that is easy to read and understand. Rest Assured provides a domain-specific language (DSL) that enables you to specify the structure of requests and responses without needing to write extensive boilerplate code.

Setting Up Rest Assured

Before we dive into testing, ensure that you have Rest Assured included in your project. If you are using Maven, add the following dependency to your pom.xml:

<dependency>

    <groupId>io.rest-assured</groupId>

    <artifactId>rest-assured</artifactId>

    <version>5.3.0</version>

    <scope>test</scope>

</dependency>

Creating a POST Request with JSON Object

To create a JSON object for a POST request, you can use a Java Map. This approach is straightforward and allows for easy manipulation of data. Below is a simple example demonstrating how to send a POST request using a Map.

Step 1: Import Required Packages

Make sure to import the necessary packages in your Java class:

import io.restassured.RestAssured;

import io.restassured.http.ContentType;

import io.restassured.response.Response;


import java.util.HashMap;

import java.util.Map;

Step 2: Create a Method for the POST Request

Next, create a method that sets up and sends the POST request. Here’s an example of how to do this:

public class ApiTest {

    

    public void sendPostRequest() {

        // Base URI of the API

        RestAssured.baseURI = "https://api.example.com";


        // Create a map for the JSON object

        Map<String, Object> jsonMap = new HashMap<>();

        jsonMap.put("name", "John Doe");

        jsonMap.put("email", "john.doe@example.com");

        jsonMap.put("age", 30);


        // Sending the POST request

        Response response = RestAssured.given()

                .contentType(ContentType.JSON) // Set content type to JSON

                .body(jsonMap) // Attach the JSON object

                .post("/users"); // Endpoint


        // Print the response

        System.out.println("Response Status Code: " + response.getStatusCode());

        System.out.println("Response Body: " + response.getBody().asString());

    }

}

Step 3: Run the Test

You can run the sendPostRequest() method in your test framework (e.g., JUnit, TestNG). Ensure that your API endpoint is running and accessible.

Step 4: Validate the Response

To make your test more robust, you should validate the response. You can assert the status code and check specific fields in the response body. Here’s how you can do this:

import static io.restassured.RestAssured.given;

import static org.hamcrest.Matchers.equalTo;


public void validateResponse() {

    given()

        .contentType(ContentType.JSON)

        .body(jsonMap)

    .when()

        .post("/users")

    .then()

        .statusCode(201) // Assert that the status code is 201 (Created)

        .body("name", equalTo("John Doe")) // Validate the response body

        .body("email", equalTo("john.doe@example.com"));

}

Followers