@ApiResponse swagger springfox-使用自定义响应容器

时间:2018-12-17 15:02:46

标签: spring-boot swagger springfox

我正在尝试将自定义容器显示为大胆的成功响应。我无法为此描述所需的模型

@ApiResponse (code = 200, message = "Successfully retrieved report info", response = PagedResponse.class

PagedResponseInfo实际上是一个自定义集合

public class PagedResponse<T> {

    private long page;
    private long pageSize;
    private long totalRecords;
    private List<T> records;
}

如果要在其中包含 Report 对象的集合,该如何指定容器?有人可以帮我吗?我在弹簧靴中使用springfox swagger -2.9.2

1 个答案:

答案 0 :(得分:1)

您需要在responseContainer批注中定义@ApiResponse属性。

/**
 * Declares a container wrapping the response.
 * <p>
 * Valid values are "List", "Set" or "Map". Any other value will be ignored.
 */
String responseContainer() default "";

您正在寻找的值List。它将把您的PagedResponse<ReportInfo>包装在一个容器中。

@ApiResponse(
    code = 200,
    message = "Successfully retrieved report info",
    response = PagedResponse.class,
    responseContainer = "List")