java - Swagger UI 不显示所有 header 值

Question

我有 Spring Boot REST Controller ，其 header 可以有超过 1 个值:

@RestController
@RequestMapping(value = "/example", headers = {"version=v1", "version=v2"})
@Api(value = "Example API")
public class ExampleController {

并使用Springfox实现了Swagger。当我加载 Swagger UI 时，我可以从版本标题列表中看到并仅选择 v1 选项。如何在 Swagger UI 中显示要选择的所有 header 值？如何更改 Swagger UI 列表中的默认 header 值？

Answer 1

在 Controller 方法上使用 ApiImplicitParams:

@ApiImplicitParams({
    @ApiImplicitParam(name = "version", allowableValues="v1,v2", required = false, dataType = "String", paramType = "header")
})

与 allowableValues :

1. To set a list of values, provide a comma-separated list. For example: first, second, third.
2. To set a range of values, start the value with "range", and surrounding by square brackets include the minimum and maximum values, or round brackets for exclusive minimum and maximum values. For example: range[1, 5], range(1, 5), range[1, 5).
3. To set a minimum/maximum value, use the same format for range but use "infinity" or "-infinity" as the second value. For example, range[1, infinity] means the minimum allowable value of this parameter is 1.