java - Springfox Swagger2 - @ApiOperation 不起作用

Question

我使用 springfox-swagger2 作为 Spring MVC REST API。一切都与 swagger 配合良好，但我的问题是我无法向我的 swagger 文档添加附加信息。

Maven 依赖关系:

<!-- 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",
                "mail@mail.com", "mail@mail.com", " ", " ");
        return apiInfo;
    }
}

我的 Controller 类:

@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 时会显示 Controller 、方法以及除 @ApiOperation 和 @ApiImplicitParams 中定义的附加信息之外的所有内容。有谁知道问题来自哪里？参数也不在从 swagger 创建的 JSON 文件中。

Answer 1

尝试将您的 customImplementation() 方法替换为:

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

构建项目，然后您的附加信息应该会出现。

编辑:我不知道这是否有什么区别，但我正在使用这些依赖项:

    <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>