如何在Swagger中注释对象响应数组

Question

我必须调试使用Swagger开发的RESTAPI Java项目。我是新手，所以我对如何做某些事情有点困惑。例如，这里有一种方法：

@GET
@Path("/location/name")
@Produces({MediaType.APPLICATION_JSON})
@Operation(
    summary = "Get location information",
    tags = {"Information"},
    responses = {
        @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(implementation = LocationResponse.class)), description = "Get location information"),
        @ApiResponse(responseCode = "500", description = "Error: Internal Server Error")
    }
)
public Response searchLocationByName(
    @Parameter(description = "Location name", required = true) @DefaultValue("Barcelona") @QueryParam("name") String locationName
) { /* METHOD CODE */ }

代码 200 的@ApiResponse不是 LocationResponse 类型，而是 ArrayList 类型

谢啦！




Answer 1

对于PageDto

Answer 2

使用@ArraySchema而不是纯@Schema来定义数组类型的输入或输出数据。