在扬鞭API响应对象的集合名单(Set List of Objects in Swagger API

我想给使用扬鞭API的响应对象的列表。

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

我有一个类 -

class Item{
   int id;
   String item_name;
}

我要像一个回应 -

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

我怎样才能做到这一点。 任何帮助，将不胜感激。

Answer 1:

您还可以设置这样的ApiReponse：

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

这将返回：

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

Answer 2:

只是包装在这样一个对象列表：

public class ItemWrapper{
private List<Item> items;
}

并把阶级ItemWrapper作为API的回应：

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

文章来源: Set List of Objects in Swagger API response