описание spingfox-swagger2 в @Tag не соблюдается - PullRequest
0 голосов
/ 30 мая 2018

Я использую следующую версию библиотек springfox-swagger2 в своем проекте Spring MVC:

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>

И я хотел бы добавить описание в мой REST Controller, используя следующую соответствующую документацию:

@RestController
@RequestMapping("/admin")
@Api(tags = {"Admin API"})
@SwaggerDefinition(tags = {
    @Tag(name = "Admin API", description = "Admin interface to manage users")
})
public class AdminController {

Однако description в tags не отражается в swagger-ui.

В нем говорится следующее:

Admin API Admin Controller

Вместо:

Admin API Интерфейс администратора для управления пользователями

Чего мне не хватает?

1 Ответ

0 голосов
/ 30 мая 2018

Я обнаружил, что мне пришлось настроить docket для просмотра описаний тегов в сгенерированных документах:

@Bean
public Docket docket() {
    return new Docket(SWAGGER_2)
        ...
        .tags(
            new Tag("Admin API", "Admin interface to manage users")
        );
}
...