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

如何解决如何使用OpenAPI 3 Swagger批注指定列表

对于我的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注释记录字符串列表？

解决方法

如果我对您的理解正确，则表明"sort"参数是一个列表，您需要像下面这样使用参数array：

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

应更改为

array = @ArraySchema(implementation = String.class)