Swagger UI не показывает все значения заголовка - PullRequest
1 голос
/ 10 июня 2019

У меня есть REST-контроллер Spring Boot с заголовком, который может иметь более одного значения:

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

И использующий реализацию Swagger в Springfox.Когда я загружаю Swagger UI, я вижу и выбираю только вариант v1 из списка для заголовка версии.Как показать все значения заголовков для выбора в Swagger UI?Как изменить значение заголовка по умолчанию в списке пользовательского интерфейса Swagger?

1 Ответ

0 голосов
/ 11 июня 2019

Используется ApiImplicitParams для методов контроллера:

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

С allowableValues ​​:

  1. Чтобы задать список значений, введите запятуюразделенный список.Например: первый, второй, третий.
  2. Чтобы установить диапазон значений, начните значение с «диапазона», а квадратные скобки включают минимальные и максимальные значения или круглые скобки для исключительного минимума и максимума.ценности.Например: диапазон [1, 5], диапазон (1, 5), диапазон [1, 5).
  3. Чтобы установить минимальное / максимальное значение, используйте тот же формат для диапазона, но используйте «бесконечность» или«-infinity» как второе значение.Например, диапазон [1, бесконечность] означает, что минимально допустимое значение этого параметра равно 1.
...