SpringBoot中如何使用配置禁用swagger呢？

转自:
http://www.java265.com/JavaCourse/202204/2931.html
SpringBoot:
        Spring Boot是由Pivotal团队提供的全新框架，其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。通过这种方式，Spring Boot致力于在蓬勃发展的快速应用开发领域(rapid application development)成为领导者
 
在生产环境中，我们需关闭swagger配置，避免接口对外暴露而产生各种危险，具体的操作方式如下所示:
禁用方式1： 使用@Value

1. package com.java265;
2. import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
3. import org.springframework.context.annotation.Bean;
4. import org.springframework.context.annotation.Configuration;
5. import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
6. import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
7. import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
8. import springfox.documentation.builders.ApiInfoBuilder;
9. import springfox.documentation.builders.PathSelectors;
10. import springfox.documentation.builders.RequestHandlerSelectors;
11. import springfox.documentation.service.ApiInfo;
12. import springfox.documentation.service.Contact;
13. import springfox.documentation.spi.DocumentationType;
14. import springfox.documentation.spring.web.plugins.Docket;
15. import springfox.documentation.swagger2.annotations.EnableSwagger2;
17. @Configuration
18. @EnableSwagger2
19. public class Swagger2Config extends WebMvcConfigurerAdapter {
21.     @Value("${swagger.enable}")
22.     private Boolean enable;
24.     @Bean
25.     public Docket createRestApi() {
26.         return new Docket(DocumentationType.SWAGGER_2)
27.                 .enable(enable)
28.                 .apiInfo(apiInfo())
29.                 .select()
30.                 .apis(RequestHandlerSelectors.basePackage("com.dc.controller"))
31.                 .paths(PathSelectors.any())
32.                 //.paths(PathSelectors.none())
33.                 .build();
34.     }
36.     private ApiInfo apiInfo()  {
37.         return new ApiInfoBuilder()
38.                 .title("auth系统数据接口文档")
39.                 .description("此系统为新架构Api说明文档")
40.                 .termsOfServiceUrl("")
41.                 .contact(new Contact("admin@java265.com", "", "*********"))
42.                 .version("1.0")
43.                 .build();
44.     }
46.     /**
47.      * swagger ui资源映射
48.      * @param registry
49.      */
50.     @Override
51.     public void addResourceHandlers(ResourceHandlerRegistry registry) {
52.         registry.addResourceHandler("swagger-ui.html")
53.                 .addResourceLocations("classpath:/META-INF/resources/");
55.         registry.addResourceHandler("/webjars/**")
56.                 .addResourceLocations("classpath:/META-INF/resources/webjars/");
57.     }
59.     /**
60.      * swagger-ui.html路径映射，浏览器中使用/api-docs访问
61.      * @param registry
62.      */
63.     @Override
64.     public void addViewControllers(ViewControllerRegistry registry) {
65.         registry.addRedirectViewController("/api-docs","/swagger-ui.html");
66.     }
67. }

复制代码

方式二：使用Profile注解

使用注解@Profile({“dev”,“test”})
在开发或测试环境开启

1. package com.java265.config;
3. import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
4. import org.springframework.context.annotation.Bean;
5. import org.springframework.context.annotation.Configuration;
6. import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
7. import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
8. import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
9. import springfox.documentation.builders.ApiInfoBuilder;
10. import springfox.documentation.builders.PathSelectors;
11. import springfox.documentation.builders.RequestHandlerSelectors;
12. import springfox.documentation.service.ApiInfo;
13. import springfox.documentation.service.Contact;
14. import springfox.documentation.spi.DocumentationType;
15. import springfox.documentation.spring.web.plugins.Docket;
16. import springfox.documentation.swagger2.annotations.EnableSwagger2;
18. @Configuration
19. @EnableSwagger2
20. @Profile({“dev”,“test”})
21. public class Swagger2Config extends WebMvcConfigurerAdapter {
23.     @Bean
24.     public Docket createRestApi() {
25.         return new Docket(DocumentationType.SWAGGER_2)
26.                 .apiInfo(apiInfo())
27.                 .select()
28.                 .apis(RequestHandlerSelectors.basePackage("com.dc.controller"))
29.                 .paths(PathSelectors.any())
30.                 //.paths(PathSelectors.none())
31.                 .build();
32.     }
34.     private ApiInfo apiInfo()  {
35.         return new ApiInfoBuilder()
36.                 .title("auth系统数据接口文档")
37.                 .description("此系统为新架构Api说明文档")
38.                 .termsOfServiceUrl("")
39.                 .contact(new Contact("*****", "", "**"))
40.                 .version("1.0")
41.                 .build();
42.     }
44.     /**
45.      * swagger ui资源映射
46.      * @param registry
47.      */
48.     @Override
49.     public void addResourceHandlers(ResourceHandlerRegistry registry) {
50.         registry.addResourceHandler("swagger-ui.html")
51.                 .addResourceLocations("classpath:/META-INF/resources/");
53.         registry.addResourceHandler("/webjars/**")
54.                 .addResourceLocations("classpath:/META-INF/resources/webjars/");
55.     }
57.     /**
58.      * swagger-ui.html路径映射，浏览器中使用/api-docs访问
59.      * @param registry
60.      */
61.     @Override
62.     public void addViewControllers(ViewControllerRegistry registry) {
63.         registry.addRedirectViewController("/api-docs","/swagger-ui.html");
64.     }
65. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！