Swagger2 多环境安全配置

Posted 2021-09-05 被雨遗忘的夏天

一、 生产环境关闭 Swagger我们该怎么做？

1、 在 配置文件新增开关

#swagger 开关
swagger2.enable=true

2、 修改 SwaggerConfifig 动态设置开关

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Value("${swagger2.enable}")
    private boolean enable;
    @Bean
    public Docket createRestApi() {
 return new Docket(DocumentationType.SWAGGER_2)
               .apiInfo(apiInfo())// 创建该Api的基本信息（这些基本信息会展现在文档页面中）
               .select()// 函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger ui来展现
               .apis(RequestHandlerSelectors.basePackage("com.yingxue.lesson.controller"))// 指定需要扫描的包路路径
               .paths(PathSelectors.any())
               .build()
               .enable(enable)// 设置开关
               ;
   }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
               .title("多环境安全配置实战")
               .description("生产环境关闭 swagger")
               .termsOfServiceUrl("")
               .version("1.0")
               .build();
   }
}