java - 如何使用 Swagger 记录 List 类型的 Spring MVC 请求参数

Question

Spring Boot 2.1.8、Spring Web 5.1.9、Springfox Swagger 2.8.0、Swagger 注释/模型 1.5.14

我的RestController方法签名如下所示:

    @ApiOperation("List statuses")
    @GetMapping(produces = APPLICATION_JSON_VALUE)
    public ListResult<Status> listStatuses(
            @ApiParam("Filter given IDs")
            @RequestParam(value = "id", required = false, defaultValue = "") List<String> ids,
            @ApiParam(value = "Sort by property value", allowMultiple = true, format = "propertyName:<asc|desc>", type = "array")
            @RequestParam(value = "_sort", required = false, defaultValue = "") List<Sort> sorts
    )

ids正如我所期望的那样记录 - 我可以输入多个单独的值:

但是，_sort始终记录为单个字符串，无论我如何使用 @ApiParam 的不同选项。有一个定制Spring Converter<String, Sort>已注册 bean。

如何强制 Swagger 处理 _sort参数作为字符串列表，其中每个项目的格式必须为 "propertyName:<asc|desc>" ？

Answer 1

使用@ApiImplicitParam，您可以强制 Swagger _sort 参数作为字符串列表

@ApiImplicitParam(name = "_sort", allowMultiple = true, dataType = "string", format = "propertyName:<asc|desc>", paramType = "query",
            value = "Sort by property value")