Springfox Swagger2 - @ApiOperation не работает

Я использую springfox-swagger2 для своего Spring MVC REST API. Все хорошо работает с swagger, но моя проблема в том, что я не могу добавить дополнительную информацию в свою документацию по swagger.

Зависимость Мейвена:

<!-- Swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.2.2</version>
</dependency>

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

Мой класс конфигурации Swagger:

@Configuration
@EnableWebMvc
@EnableSwagger2
@ComponentScan("path.to.controller.package")
public class SwaggerConfig {

    @Bean
    public Docket customImplementation() {
        return new Docket(DocumentationType.SPRING_WEB).apiInfo(apiInfo());
    }

    @Bean
    public UiConfiguration uiConfig() {

        return UiConfiguration.DEFAULT;
    }

    private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfo("Service API", "Simple REST Service", "0.0.1",
                "[email protected]", "[email protected]", " ", " ");
        return apiInfo;
    }
}

Мой класс контроллера:

@RestController
@RequestMapping("/persons")
public class PersonController {

    Logger LOGGER = LoggerFactory.getLogger(PersonController.class);

    @RequestMapping(value = "/{id}", method = RequestMethod.GET, headers = "Accept=application/json")
    @ApiOperation(value = "doStuff", response = Person.class)
    @ApiImplicitParams({@ApiImplicitParam(name="Authorization", value="MY DESCRIPTION")})
    public @ResponseBody Person getPerson(@PathVariable String id,
          @RequestHeader(value = "Authorization") String authToken) throws Exception {

          //do things and return
    }
}

Итак, при вызове swagger-ui отображается контроллер, метод, все, кроме моей дополнительной информации, определенной в @ApiOperation и @ApiImplicitParams. У кого-нибудь есть идея, откуда может возникнуть проблема? Параметров также нет в файле JSON, созданном из swagger.


java swagger-ui swagger-2.0 springfox
person K.E.    schedule 19.02.2016    source источник

Ответы (1)


arrow_upward
3
arrow_downward

Попробуйте заменить свой метод customImplementation() на:

@Bean
public Docket customImplementation() {
    return new Docket(DocumentationType.SWAGGER_2)
        .select()
        .apis(RequestHandlerSelectors.any())
        .build()
        .apiInfo(apiInfo());
}

Создайте проект, после чего должна появиться ваша дополнительная информация.

EDIT: я не знаю, имеет ли это какое-то значение, но я использую эти зависимости:

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.3.1</version>
    </dependency>

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.1.2</version>
    </dependency>
person haihui    schedule 19.02.2016
comment
отлично - спасибо, изменение в customImplementation() заставило его работать - person K.E.; 19.02.2016