Set List of Objects in Swagger API response

Question

I want to send a list of objects in the response of an API using Swagger.

@ApiResponse(code = 200, message = ApiResponseMessages.ITEM_FETCHED, 
response = "")

I have a class -

class Item{
   int id;
   String item_name;
}

I want a response like -

{
    {
       "id" : 0,
       "item_name" : ""
    }
    {
       "id" : 0,
       "item_name" : ""
    }
    {
       "id" : 0,
       "item_name" : ""
    }
}

How can i do this. Any help would be appreciated.

score 29 · Accepted Answer · answered Jun 18 '19 at 19:34

You also can set a ApiReponse like this:

@ApiResponse(code = 200, message = ApiResponseMessages.ITEM_FETCHED,
             response = Item.class, responseContainer = "List"
            )

It's will return:

[
    {
       "id" : 0,
       "item_name" : ""
    },
    {
       "id" : 0,
       "item_name" : ""
    },
    {
       "id" : 0,
       "item_name" : ""
    }
]

score 14 · Answer 2 · answered Apr 07 '21 at 14:30

14

For the new package: io.swagger.v3.oas.annotations.responses.ApiResponse

You need to do this (with @ArraySchema annotation):

@ApiResponse(responseCode = "200", description = "",
            content = {@Content(
                mediaType = "application/json",
                array = @ArraySchema(schema = @Schema(implementation = Bar.class))
            )}
)

answered Apr 07 '21 at 14:30

rios0rios0

735
7
20

This should be the right answer – jics Feb 25 '22 at 06:31

score 7 · Answer 3 · edited Dec 15 '21 at 20:46

7

You can use of responseContainer = "List" as below:

@ApiOperation(value = "retrieve items", response = Item.class, responseContainer = "List")

edited Dec 15 '21 at 20:46

BuZZ-dEE

6,075
12
66
96

answered Jun 12 '20 at 18:03

Shashank

709
8
16

Set List of Objects in Swagger API response

3 Answers3

Linked