如何使用 OpenAPI 3 Swagger 注释指定列表

Question

对于我的 API，我正在制作一个元注释来处理

Pagable

参数，为此我需要将字符串列表注释为将显示在 Swagger UI 中的参数。

import io.swagger.v3.oas.annotations.Parameter;

@Parameter(name = "sort", in = ParameterIn.QUERY, schema = @Schema(implementation = String.class, type = "query"))
public @interface PageableQueryParameters {}

为了在 Spring

Pageable

中按多个条件排序，需要以字符串列表的形式提供排序参数。不幸的是我不知道如何将排序参数声明为列表。

如何使用 Swagger 的 OpenAPI 3 注释记录字符串列表？

Answer 1

如果我理解正确，为了表明

"sort"

参数是一个列表，您需要使用参数

array

，如下所示：

schema = @Schema(implementation = String.class, type = "query"

应改为

array = @ArraySchema(implementation = String.class)

Answer 2

你应该使用这个：

数组 = @ArraySchema(模式 = @Schema(实现 = String.class)