RestAssured: How to check the length of json array response?

Question

I have an endpoint that returns a JSON like:

[
  {"id" : 4, "name" : "Name4"},
  {"id" : 5, "name" : "Name5"}
]

and a DTO class:

public class FooDto {
    public int id;
    public String name;
}

Now, I'm testing the length of the returned json array this way:

@Test
public void test() {
    FooDto[] foos = RestAssured.get("/foos").as(FooDto[].class);
    assertThat(foos.length, is(2));
}

But, is there any way to do it without cast to FooDto array? Something like this:

@Test
public void test() {
    RestAssured.get("/foos").then().assertThat()
      .length(2);
}

score 78 · Accepted Answer · answered Apr 07 '16 at 08:49

78

Solved! I have solved it this way:

@Test
public void test() {
    RestAssured.get("/foos").then().assertThat()
      .body("size()", is(2));
}

answered Apr 07 '16 at 08:49

Héctor

24,444
35
132
243

Hi, How to pass size restriction, when doing non-BDD style rest-assured. viz- public Response putRequest() { httpRequest.header("Content-Type",ContentType.JSON); httpRequest.header("Accept",ContentType.JSON); httpRequest.header("Authorization", System.getProperty("apiKey")); return httpRequest.request(Method.PUT); } – user2451016 Mar 14 '22 at 20:22

Michel · Answer 2 · 2019-12-18T14:02:39.870

14

You can simply call size() in your body path:

Like:

given()
            .accept(ContentType.JSON)
            .contentType(ContentType.JSON)
            .auth().principal(createPrincipal())
            .when()
            .get("/api/foo")
            .then()
            .statusCode(OK.value())
            .body("bar.size()", is(10))
            .body("dar.size()", is(10));

edited Dec 18 '19 at 14:02

answered Dec 05 '19 at 13:36

Michel

9,220
13
44
59

score 9 · Answer 3 · answered Sep 19 '16 at 05:56

9

There are ways. I solved with the below

@Test
public void test() {
 ValidatableResponse response = given().when().get("/foos").then();
 response.statusCode(200);
 assertThat(response.extract().jsonPath().getList("$").size(), equalTo(2));
}

using restassured 3.0.0

answered Sep 19 '16 at 05:56

arulraj.net

4,579
3
36
37

is it possible to limit /batch the restassured response body? – user2451016 Apr 06 '22 at 14:46

score 5 · Answer 4 · answered Jul 14 '17 at 05:06

I solved similar task wit GPath.

Response response = requestSpec
                .when()
                .get("/new_lesson")
                .then()
                .spec(responseSpec).extract().response();

Now I can extract response body as String and use built-in GPath capabilities

String responseBodyString = response.getBody().asString();

assertThat(from(responseBodyString).getList("$").size()).isEqualTo(YOUR_EXPECTED_SIZE_VALUE);
assertThat(from(responseBodyString).getList("findAll { it.name == 'Name4' }").size()).isEqualTo(YOUR_EXPECTED_SUB_SIZE_VALUE);

For full example see http://olyv-qa.blogspot.com/2017/07/restassured-short-example.html

score 5 · Answer 5 · answered Jan 24 '19 at 00:37

This is what you need to do in order to get size.

Response response = 
given()
.header("Accept","application/json")
.when()
.get("/api/nameofresource")
.then()
.extract()
.response();

once you have the response, you can do the following to get the size.

int size = response.jsonPath().getList("id").size();

hope this helps. :)

score 4 · Answer 6 · answered May 28 '18 at 06:17

@Héctor

[   
   {"id" : 4, "name" : "Name4"}, 
   {"id" : 5, "name" : "Name5"}
]

It was really unlucky example. Here you have matrix [2,2].

If you create something like this:

[   
   {"id" : 4, "name" : "Name4"}, 
   {"id" : 5, "name" : "Name5"}, 
   {"id" : 6, "name" : "Name6"} 
]

Now you still get passed test:

@Test
public void test() {
    RestAssured.get("/foos").then().assertThat()
      .body("size()", is(2));
}

Consider about whether it was intentional. body("size()",is(2)); Have checking length of one node instead of number of records in response.

score 2 · Answer 7 · answered Dec 03 '21 at 10:14

2

Also possible option is hasSize() matcher along with "." path:

import static org.hamcrest.Matchers.hasSize;

...

@Test
public void test() {
    RestAssured.get("/foos").then().assertThat()
      .body(".", hasSize(2));
}

answered Dec 03 '21 at 10:14

Rib47

2,336
2
14
15

brudermoren · Answer 8 · 2022-02-05T05:12:10.217

0

Try this :)

   Response response = RestAssured
   .given()    
        .header("Content-Type", "application/json")    
   .when()    
        .get("api/v1/blablabla/");    
        
    int responseLength = 
    response.body().jsonPath().getList("$").size();

edited Feb 05 '22 at 05:12

answered Feb 05 '22 at 05:07

brudermoren

11
2

Your answer could be improved with additional supporting information. Please [edit] to add further details, such as citations or documentation, so that others can confirm that your answer is correct. You can find more information on how to write good answers [in the help center](/help/how-to-answer). – Cristik Feb 05 '22 at 12:23

RestAssured: How to check the length of json array response?

8 Answers8