在 Swagger API 响应中设置对象列表

Question

我想使用 Swagger 在 API 的响应中发送对象列表。

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

我有一个 class -

class Item{
   int id;
   String item_name;
}

我想要这样的回复 -

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

我该怎么做。任何帮助将不胜感激。

Answer 1

您也可以像这样设置 A​​piReponse：

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

会的 return:

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

Answer 2

您可以使用 responseContainer = "List" 如下：

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

Answer 3

对于新包：io.swagger.v3.oas.annotations.responses.ApiResponse

您需要这样做（使用 @ArraySchema 注释）：

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