spring boot 設置swagger 上線關閉

原創

康康滴泡沫

2020-02-21 22:25

swagger技術管理項目接口文檔,是一個很不錯的選擇。但是忽然想到上線沒有關閉，那麼後果就帶勁了！！！

從網上也找了一部分博客，有一部分沒有成功，現在整理下最終嘗試成功的步驟！

1.pom.xml中

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
            <exclusions>
                <exclusion>
                    <groupId>io.swagger</groupId>
                    <artifactId>swagger-models</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-models</artifactId>
            <version>1.5.21</version>
        </dependency>
   <dependency>
         <groupId>io.springfox</groupId>
         <artifactId>springfox-swagger-ui</artifactId>
         <version>2.9.2</version>
  </dependency>

2.在application-dev.yaml 配置文件中加入 true爲打開 false 爲關閉

(不同環境配置不同狀態,application.yaml上線直接修改對應環境即可,省事)

swagger:
  show: true

3.配置Swagger2Configuration文件

@Configuration
@EnableSwagger2
public class Swagger2Configuration {

    @Value("${swagger.show}")
    private boolean swaggerShow;

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .enable(swaggerShow)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .paths(PathSelectors.any())
                .build();
    }
    /**
     * 構建api文檔的詳細方法
     *
     * @return ApiInfo
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //頁面標題
                .title("Swagger2 構建Api")
                //創建
                .termsOfServiceUrl("http://www.baidu.com")
                .version("1.0.0")
                //描述
                .description("API 描述")
                .build();
    }

}