当前位置: 首页 > 知识库问答 >
问题:

@api响应昂首阔步springfox-使用自定义响应容器

孟承嗣
2023-03-14

我试图显示一个自定义容器,作为一个成功的响应。我无法描述这方面所需的模型

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

THIS Paged响应信息实际上是一个自定义集合

public class PagedResponse<T> {

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

如果其中包含一个Report对象集合,如何指定容器?有人能帮帮我吗?我在Spring引导中使用springfox swagger-2.9.2

共有1个答案

林绪
2023-03-14

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

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

列表就是您要查找的。它将包装您的页面响应

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

 类似资料:
  • 我把招摇过市融入了一个点。net核心API应用程序使用Swashback。当我在不提供凭证的情况下通过Swagger UI执行API时,它会像预期的那样返回“401-Unauthorized”响应。 但是它没有显示我已经配置为作为主体返回的自定义错误响应的错误响应。它确实返回标题如下图。 当我通过Postman执行相同的API时,它会返回如下自定义错误响应。 我需要的是,我还需要在swagger

  • 问题内容: 我想知道如何用昂扬的方式记录枚举。 根据JavaDoc 数据类型。请参阅文档以获取受支持的数据类型。如果数据类型是自定义对象,请设置其名称,或不设置任何名称。如果是枚举,请为枚举常量使用’string’和allowableValues。 但是我没有找到一些好的Java示例如何真正使用它,规范在这里。 第一服务 第二服务 输入项 天 输出量 pom.xml 您可以在此处查看结果。 我看到

  • 我从http请求中得到以下形式的响应:它是一个由未命名数组和对象组成的数组。我无法为这种情况找到合适的Swagger(开放API)规范。

  • 数据类型。有关支持的数据类型,请参见文档。如果数据类型是自定义对象,请设置它的名称,或者不设置任何名称。对于枚举,使用'string'和allowableValues作为枚举常量。 但是我没有找到一些好的Java示例如何真正使用它,规范在这里。 你可以在这里看到结果。 我认为是个问题... 你知道吗?

  • 我们正在为我们的Laravel REST API实现开发Swagger文档。几个POSTendpoint将使用CSV作为参数内容类型。 Swagger中是否有一种方法可以让“立即尝试”功能与CSV POST文件上传一起使用? 下面是我们的留档http://api.curvecompass.com/docs/#/ 我们的Laravel POST函数可以正确地与CSVendpoint一起工作,而不是与

  • 问题内容: 我正在尝试使用swagger定义post端点,但是不允许使用该参数: 当我跑步时,我得到这个: 我的规格有什么问题? 问题答案: 您可能正在混合使用OpenAPI / Swagger 2.0和OpenAPI 3.0语法。您的规格似乎是2.0,但是关键字是3.0功能。在2.0中,请求正文被定义为正文参数: 更多信息:描述请求正文