Переименование API в Swagger с помощью Spring - PullRequest
0 голосов
/ 03 декабря 2018

Я понимаю, что при документировании API с помощью Swagger в Spring я могу изменить описание API, добавив аннотацию @Api, но добавив ее следующим образом:

@Api(value= "NEW_NAME", description="NEW_DESCRIPTION")

Только описаниеизменилось, а не имя.

как видно здесь

enter image description here

Кроме того, я не уверен, где находятся имя и описание по умолчаниюИсходя из того, что перед добавлением API имя кажется производным от имени контроллера, но от описания;что для меня выглядит естественно и по-человечески почти как жестко закодированная строка с заглавными буквами и все такое.Я запустил поиск по коду и не смог найти эти строки.Откуда Swagger получает эти значения?

спасибо

1 Ответ

0 голосов
/ 04 декабря 2018

Атрибут, который вы ищете: tags.Таким образом, вы можете избежать группировки по имени контроллера.

Из Javadoc @Api tags:

Теги могут использоваться для логической группировки операций по ресурсам или любому другому квалификатору.

Например:

@Api(value = "/customers", tags = "customers", description = "Manage Customer")

По умолчанию Springfox создает API с именем {controller-name}-controller и описанием {Controller Name} Controller (см. Как изменить контроллер по умолчаниюИмя в Swagger Spring ).

...