REST Assured – Creating JSON Object and Array Request Body

Creating JSON Object Request Body Using Java Map💻

It is not a good practice to hardcode the JSON request body if you want to create a payload at run time or if you have the dynamic payload. It is best practice to create a payload that you can easily maintain, manage, update, and retrieve values from it.

We can easily create JSON object using Map in Java because both support the key-value pairs feature.

Let’s understand this with the help of an example.

Let’s take a simple JSON object. 

{
    "username" : "CodingNinjas",
    "password" : "ninjas@123",
    "firstname" : "Coding",
    "lastname" : "Ninjas"
}

You can also try this code with Online Java Compiler

Run Code

The Java Map for the above JSON object is created below, Since all the key-value pairs are string, we can create a generic Map.

Map<String,String> authorizationPayload = new HashMap<String,String>();
authorizationPayload.put("username", "CodingNinjas");
authorizationPayload.put("password", "ninjas@123");
authorizationPayload.put("firstname", "Coding");
authorizationPayload.put("lastname", "Ninjas");

You can also try this code with Online Java Compiler

Run Code

Complete Example

package CodingNinjas;

import java.util.HashMap;
import java.util.Map;

import org.testng.annotations.Test;

import io.restassured.RestAssured;
import io.restassured.http.ContentType;

public class CreatingJSONRequestBodyUsingMap {

    @Test
    public void bodyAsMap() {
        Map<String, String> authorizationPayload = new HashMap<String, String>();
        authorizationPayload.put("username", "CodingNinjas");
        authorizationPayload.put("password", "ninjas@123");
        authorizationPayload.put("firstname", "Coding");
        authorizationPayload.put("lastname", "Ninjas");

        // GIVEN
        RestAssured
                .given()
                .baseUri("https://restful-booker.herokuapp.com/auth")
                .contentType(ContentType.JSON)
                .body(authPayload)
                .log()
                .all()

                // WHEN
                .when()
                .post()

                // THEN
                .then()
                .assertThat()
                .statusCode(200)
                .log()
                .all();

    }

}

You can also try this code with Online Java Compiler

Run Code

Output

Using a logger to show the JSON body, you can see the request body in the below output.

Creating JSON Array Request Body Using Java List🧑‍💻

An API may accept a JSON Array payload as well. We can easily create a JSON array using List in Java. 

Let’s understand this with the help of an example.

Let’s take a simple JSON array.

[
    {
        "username" : "CodingNinjas",
        "password" : "ninjas@123"
    },
    {
        "firstname" : "Coding",
        "lastname" : "Ninjas",
        "city":"Noida"
    }
]

You can also try this code with Online Java Compiler

Run Code

The Java List for the above JSON array is created below.

// JSON Object 
Map<String,String> authorizationPayload = new HashMap<String,String>();
authorizationPayload.put("username", "CodingNinjas");
authorizationPayload.put("password", "ninjas@123");

Map<String,String> detailsPayload = new HashMap<String,String>();
detailsPayload.put("firstname", "Coding");
detailsPayload.put("lastname", "Ninjas");
detailsPayload.put("city", "Noida");

// Creating JSON array to add both JSON objects
List<Map<String,Object>> arrayJSONPayload = new ArrayList<>();

arrayJSONPayload.add(authorizationPayload);
arrayJSONPayload.add(detailsPayload);

You can also try this code with Online Java Compiler

Run Code

Complete Example

package CodingNinjas;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.HashMap;

import org.testng.annotations.Test;

import io.restassured.RestAssured;
import io.restassured.http.ContentType;

public class CreatingJSONArray {

    @Test
    public void CreatingJSONObjectTest() {
        // JSON Object
        Map<String, String> authorizationPayload = new HashMap<String, String>();
        authorizationPayload.put("username", "CodingNinjas");
        authorizationPayload.put("password", "ninjas@123");

        Map<String, String> detailsPayload = new HashMap<String, String>();
        detailsPayload.put("firstname", "Coding");
        detailsPayload.put("lastname", "Ninjas");
        detailsPayload.put("city", "Noida");

        // Creating JSON array to add both JSON objects
        List<Map<String, Object>> arrayJSONPayload = new ArrayList<>();

        arrayJSONPayload.add(authorizationPayload);
        arrayJSONPayload.add(detailsPayload);

        // GIVEN
        RestAssured
                .given()
                .baseUri("https://restful-booker.herokuapp.com/auth")
                .contentType(ContentType.JSON)
                .body(arrayJSONPayload)
                .log()
                .all()

                // WHEN
                .when()
                .post()

                // THEN
                .then()
                .assertThat()

                // Putting status code as 500 
                .statusCode(500)
                .log()
                .all();
    }
}

You can also try this code with Online Java Compiler

Run Code

Output

You can see the JSON Array body in the output.

Must Read Array of Objects in Java

Frequently Asked Questions

What is API?

API stands for Application Programming Interface. It is a set of definitions and protocols for creating and integrating software applications. 

What is REST API?

REST (Representational State Transfer) is an architectural paradigm for establishing web services that define a set of requirements. REST API is a straightforward and flexible approach to accessing online services without going through any processing.

What is REST Assured?

REST Assured is an Open Source Java library for testing and validating REST APIs. It is a Java DSL for HTTP Builder that makes it easier to test REST-based services.

What is JSON?

JSON is a free and open-source file format and data exchange format that uses text that can be read by humans to store and send data objects made up of arrays and attribute-value pairs.

What is List in Java?

List in Java is the data structure to maintain the ordered collection. It contains index-based methods to insert, delete, update, and search the elements.

Conclusion

In this article, we have extensively discussed how to create JSON Object and Array request body in REST Assured. I hope you enjoyed reading this article on REST Assured – Creating JSON Object and Array Request Body.

If you want to learn more, check out our articles on Ignore Default and Null values in Payload in Rest Assured, Implementing DELETE Method to Delete a User Resource, Technological Services in Ready API, What Is Web2Py?, Why To Use Web2py?, Postbacks and Internationalization in web2py, Third Party Modules In Web2py, Tasks In Web2py, and  XML in Web2py.

Recommended problems -

• Maximum sum subarray of size k
• Max circular subarray sum
• Subarray sums divisible by k
• Shortest subarray with sum at least k

Also, check out these exciting courses from coding ninjas to expand your knowledge, Coding Course, Code Studio, Interview Experience, Guided Path, Interview Problems, Test Series, Library, and Resources. 

Happy Coding!