首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >java @ApiResponse如何使用以下方法将列表定义为返回对象

java @ApiResponse如何使用以下方法将列表定义为返回对象
EN

Stack Overflow用户
提问于 2021-11-01 16:28:55
回答 1查看 1.9K关注 0票数 3

我使用的SpringBoot具有以下依赖项

<dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> <version>1.5.12</version> </dependency>

控制器类(@RestController)有一个入口点(@ return ),这个入口点应该返回对象的列表:MyClass.java。我在方法上面添加了Swagger注释,以便通过swagger页面创建API文档。

swagger文档应指示返回对象的类型。

List< MyClass>

但我该怎么做呢?如果我做了

@Schema(implementation= List< MyClass >.class)

编译错误。

摆动注释:

@operation(.)@ApiResponse(value={ @ApiResponse(responseCode = "200",description = "successful“),content ={ @Content(mediaType = "application/json",schema = @Schema(implementation =?) }),@ApiResponse(.),@ApiResponse(.)@/aaa,MediaType.APPLICATION_JSON_VALUE)公共列表getAaa(.){返回.}

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2021-11-01 17:26:42

为此,您需要使用ArraySchema注释,并将其分配给array属性,而不是@Content注释的schema属性。您不需要只指定List.class的类型参数MyClass.class

代码语言:javascript
运行
复制
    @Operation(
            summary = "Get a list of users",
            description = "Get a list of users registered in the system",
            responses = {@ApiResponse(
                    responseCode = "200",
                    description = "The response for the user request",
                    content = {
                            @Content(
                                    mediaType = "application/json",
                                    array = @ArraySchema(schema = @Schema(implementation = User.class))
                            )
                    })
            }
    )
    @GET
    @SecurityRequirement(name = "JWT")
    @Path("/user")
    public List<User> getUsers() {
        return null;
    }
票数 5
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/69799828

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档