4

我正在从 2.x 升级到 SpringFox Swagger 3.0.0，它引入了 Spring Boot 启动器springfox-boot-starter依赖项，从而消除了对基于 2.x 的需求SwaggerConfig：

/**
 * NO LONGER NEEDED
 */
@Configuration
@EnableSwagger2
@Profile({"local", "dev", "beta"}) // <- HOW TO DISABLE IN PROD INSTEAD OF THIS
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

现在我不再需要这个@Configuration，它允许我指定我的环境配置文件@Profile并因此在生产中禁用 Swagger，如何在 SpringFox Swagger-UI 3.x 中禁用 Swagger？

注意：这里讨论了基于 Spring Security 的方法，这对于某些人来说可能是一种选择，但对于这种情况不是一种选择，原因有两个：

  • 我的应用程序不使用 Spring Security，并且无法包含spring-boot-security-starter依赖项
  • 它需要将所有其他端点列入白名单才能让它们再次工作，这是不可接受的
4

1 回答 1

9

答案不容易找到，并且不在 SpringFox 的迁移指南或文档中（应该在哪里）。

Swagger UI 3.0.0 的正确和迄今为止最好的答案在这里。

只需添加springfox.documentation.enabled=[true|false]到目标环境的 application.properties 或 application.yml。

顺便说一句，很高兴看到 SpringFox 文档中列出的所有可用 Spring Boot 属性列表的部分。

于 2021-05-07T18:02:42.163 回答