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

Question

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

@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 对象的集合，我该如何指定容器？有人可以帮我吗？我在 spring boot

中使用 springfox swagger -2.9.2

Answer 1

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

/**
 * 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")

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

@ApiResponse swagger springfox - use of custom response container

swagger

spring-boot

springfox