配置不同环境下启用swagger,在生产环境关闭swagger

时间:2022-05-04
本文章向大家介绍配置不同环境下启用swagger,在生产环境关闭swagger,主要内容包括前言、配置、基本概念、基础应用、原理机制和需要注意的事项等,并结合实例形式分析了其使用技巧,希望通过本文能帮助到大家理解应用这部分内容。

前言

Swagger使用起来简单方便,几乎所有的API接口文档都采用swagger了。使用示例:http://www.cnblogs.com/woshimrf/p/swagger.html, 现在开发中可以参考文档,但生产环境并不想暴露出去。

配置

只要在不同环境中配置是否启用就可以了。

@Value("${swagger.enable}")
private boolean enableSwagger;

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

然后,我想在dev和test环境中启用,直接在配置文件中添加配置:

swagger:
  enable: true