How to parse a JSON Object and Array response to a Java Map in Rest Assured?

Parse JSON Object Response to a Java Map

After installing the required dependency, let’s look at the theoretical approach of what we will do to parse JSON object response to a java map. We can parse the response as a Map once it is determined whether it is a JSON object. A function called as() accepts a TypeRef reference to support classes with generics. 

For instance, a Map<String, Object> can be used to represent a JSON object. Use the as() method and TypeRef to cast the JSON Object response into that type. When de-serializing a response, generic type information is specified using the abstract class TypeRef.

Let’s look at the following example to parse JSON object response to a java map:

Example:

package RestAssuredConcepts;

import java.util.Map;

import io.restassured.RestAssured;
import io.restassured.common.mapper.TypeRef;
import io.restassured.http.ContentType;

public class ParseJsonObjectResponseToMap {

    public static void main(String[] args) {

        Map <String, Object > responseBody = null;

        responseBody =
            RestAssured
            .given()
            .baseUri("https://restful-booker.herokuapp.com/")
            .basePath("booking")
            .contentType(ContentType.JSON)
            .body("{\r\n" +
                "    \"firstname\" : \"Jim\",\r\n" +
                "    \"lastname\" : \"Clarke\",\r\n" +
                "    \"totalprice\" : 5139,\r\n" +
                "    \"depositpaid\" : true,\r\n" +
                "    \"bookingdates\" : {\r\n" +
                "        \"checkin\" : \"2022-11-07\",\r\n" +
                "        \"checkout\" : \"2022-11-06\"\r\n" +
                "    },\r\n" +
                "    \"additionalneeds\" : \"Breakfast\"\r\n" +
                "}")
            .when()
            .post()
            .then()
            .extract()
            .body()
        // Extract response as Map<String,Object>
        .as(new TypeRef < Map < String, Object >> () {});

        // For printing the booking id
        System.out.println("Booking id is : " + responseBody.get("bookingid"));

        // If we do not want to use the below annotation then no problem, we can directly cast without checking

        @SuppressWarnings("unchecked")
        // Since "booking" key hold another JSON Object to parse again as Map.
        Map < String, Object > bookingDetail = (Map < String, Object > ) responseBody.get("booking");

        System.out.println("First name is " + bookingDetail.get("firstname"));

    }
}

Output: 

Explanation:

In the above example, we get a response in the form of a JSON object.  We used the JSONPath class and its methods to parse the JSON body and find the value of a certain attribute (booking id). For this, the function .as(new TypeRef<Map<String, Object>>() {}) accepts a TypeRef reference to support classes with generics (string and object). Afterwards, we send get request to ask for output from the response body.  

Must Read Array of Objects in Java

Frequently Asked Questions

What does a JSON object mean?

A JSON object is a collection of key-value pairs. The values are JSON types, while the keys are strings. A colon separates the keys and values. The key/value pair entries are separated by commas.

Are the Java map and hashmap the same?

While Java map is a Java interface used to map key-pair values, HashMap is a non-synchronized Java Collection Framework class with null values and keys.

What does client-server architecture mean?

A server provides resources and services to one or more clients using the client-server concept. A few examples include file servers, mail servers, and web servers. As a result, the server accepts the client's request.

How is JSON converted to strings?

For this, JSON.stringify() is employed. A string will be the outcome. It will adhere to JSON formatting.

Why does JSON replace XML?

JSON is made for exchanging data. It is, therefore, quicker than XML. Furthermore, a JavaScript function can parse JSON. XML, however, needs an XML parser.

Conclusion

This article briefly discussed how to parse a JSON object and array response to a java map in rest assured. We had discussed the dependencies required to parse a JSON object response to a java map. Afterwards, we discussed the theoretical aspect to parse a JSON object response to a java map. At last, we discussed the program to parse a JSON object response to a java map. Thus concluding our discussion on the topic of how to parse a JSON object response to a java map.

We hope this blog has helped you enhance your knowledge of parse a JSON object and array response to a java map in REST assured. If you like to learn more, you can check out our articles: 

•  Learn to write JSONPath expressions or JSONPath syntax and deserialise it in rest assured
•  REST Assured – Compare Two JSON using Jackson – Java Library
•  REST Assured – What is JSONpath and how to create it for simple and nested JSON Objects?
•  What is JSON Schema and validation of the schema with and without rest assured?

Recommended problems -

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

Refer to our Guided Path on Coding Ninjas Studio to upskill yourself in Data Structures and Algorithms, Competitive Programming, JavaScript, AWS and many more! If you wish to test your competency in coding, you may check out the mock test series and participate in the contests hosted on Coding Ninjas Studio! 

If you have just started your learning process and are looking for questions from tech giants like Amazon, Microsoft, Uber, etc. For placement preparations, you must look at the problems, interview experiences, and interview bundles.

Nevertheless, you may consider our paid courses to give your career an edge over others!

Happy Learning!