如何使用 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按多個條件進行排序，需要將 sort 參數作為字符串列表提供。 不幸的是，我不知道如何將 sort 參數聲明為列表。

如何使用 Swagger 的 OpenAPI 3 注釋記錄字符串列表？

Answer 1

如果我對你的理解正確，為了表明"sort"參數是一個列表，你需要使用如下所示的參數array ：

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

應該改為

array = @ArraySchema(implementation = String.class)