SpringBoot Swagger 禁用/启用配置

你的名字 2022-10-05 04:44 416阅读 0赞

### 文章目录 ###

*   *  集成
     *   *  pom.xml
         *  application.properties
         *  配置类
     *  禁用 配置项
     *  访问效果
     *  repo link

## 集成 ##

### pom.xml ###

<dependency>
    	<groupId>io.springfox</groupId>
    	<artifactId>springfox-swagger2</artifactId>
    	<version>2.9.2</version>
    </dependency>
    <dependency>
    	<groupId>io.springfox</groupId>
    	<artifactId>springfox-swagger-ui</artifactId>
    	<version>2.9.2</version>
    </dependency>

### application.properties ###

swagger.enable=true

### 配置类 ###

package com.wuyujin.msdemo.config;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.service.Contact;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    /**
     * Description config swagger-ui
     * access address rule: portocol://ip:port/appName/swagger-ui.html
     * sample： http://localhost:8888/ms/swagger-ui.html
     *
     * @ClassName com.wuyujin.msdemo.config.SwaggerConfig
     * @Version 1.0
     * @Date: 2021/6/6 2:22 下午
     * @User leung
     * @Author yujin.wu@outlook.com
     */
    @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
    
        // Boolean 优于 boolean (必须要存在该配置项，否则启动报错)
        @Value("${swagger.enable}")
        private Boolean enable;
    
        @Bean
        public Docket createRestApi(){
            Docket docker = new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(this.apiInfo())
                    .enable(enable)
                    .select()
                    .apis(RequestHandlerSelectors.any())
                    .paths(PathSelectors.any())
                    .build();
            return docker;
        }
    
        private ApiInfo apiInfo(){
            String title = "ms-demo api documents";
            String description = "这是一个demo项目";
    
            String name = "wyj";
            String url = "http://www.wuyujin.com";
            String email = "yujin.wu@outlook.com";
    
            ApiInfo apiInfo = new ApiInfoBuilder()
                    .title(title)
                    .description(description)
                    .version("1.0")
                    .contact(new Contact(name, url, email))
                    .build();
            return apiInfo;
        }
    
    }

## 禁用 配置项 ##

修改`swagger.enable`即可。  
或在 `Docker` 的 `enable(boolean)` 环节设值。

## 访问效果 ##

swagger 2 访问地址： [http://localhost:8888/ms/swagger-ui.html][http_localhost_8888_ms_swagger-ui.html]

禁用时访问：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70]

启用时访问：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70 1]

## repo link ##

代码仓库提交记录 [https://gitee.com/wuyujin1997/ms-demo/commit/683d0230423d477639f4bb2ce68cad0d1719358c][https_gitee.com_wuyujin1997_ms-demo_commit_683d0230423d477639f4bb2ce68cad0d1719358c]

[http_localhost_8888_ms_swagger-ui.html]: http://localhost:8888/ms/swagger-ui.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70]: /images/20221005/3aed172258f74e4aa01fa2b6173251ae.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d1eXVqaW4xOTk3_size_16_color_FFFFFF_t_70 1]: /images/20221005/48050208d8cc49aca45bc0ce3197048e.png
[https_gitee.com_wuyujin1997_ms-demo_commit_683d0230423d477639f4bb2ce68cad0d1719358c]: https://gitee.com/wuyujin1997/ms-demo/commit/683d0230423d477639f4bb2ce68cad0d1719358c