spring-mvc - 使用 Spring MVC 禁用 Swagger

Question

我将 Swagger 与 Spring MVC 一起使用。我想在特定环境(如生产环境)中选择性地禁用 Swagger 。我怎样才能做到这一点？

Answer 1

如果您使用 1.x 版本的 springfox以前 swagger-springmvc

当你配置你的 swagger spring-mvc 插件时，你可以使用 enable您可以根据环境/配置文件等传入 bool 值的方法。

@Bean 
public SwaggerSpringMvcPlugin customImplementation(){
    return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
        .apiInfo(apiInfo())
        .enable(environmentSpeficicBooleanFlag) //<--- Flag to enable or disable possibly loaded using a property file
        .includePatterns(".*pet.*");
}

另一种方法是使用 Spring 型材

@Bean
@Profile("production")
public SwaggerSpringMvcPlugin customImplementation(){
    return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
        .apiInfo(apiInfo())
        .enable(false) //<--- Flag set to false in the production profile
        .includePatterns(".*pet.*");
}

如果您使用 2.x 版本的 springfox

当你配置你的 swagger spring-mvc 插件时，你可以使用 enable您可以根据环境/配置文件等传入 bool 值的方法。

@Bean 
public Docket customImplementation(){
    return new Docket(SWAGGER_2)
        .apiInfo(apiInfo())
        .enable(environmentSpeficicBooleanFlag) //<--- Flag to enable or disable possibly loaded using a property file
        .includePatterns(".*pet.*");
}

另一种方法是使用 Spring 型材

@Bean
@Profile("production")
public Docket customImplementation(){
    return new Docket(SWAGGER_2)
        .apiInfo(apiInfo())
        .enable(false) //<--- Flag set to false in the production profile
        .includePatterns(".*pet.*");
}