pringMVC集成springfox-swagger2和springfox-swagger-ui很简单,只需要两步:

(1)pom中添加依赖

  1. <dependency>
  2. <groupId>io.springfox</groupId>
  3. <artifactId>springfox-swagger-ui</artifactId>
  4. <version>${springfox-swagger.version}</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>io.springfox</groupId>
  8. <artifactId>springfox-swagger2</artifactId>
  9. <version>${springfox-swagger.version}</version>
  10. </dependency>

(2)添加Swagger的配置类:

  1. @Configuration
  2. @EnableSwagger2
  3. @EnableWebMvc
  4. @ComponentScan("com.XXX.controller")
  5. public class SwaggerConfig{
  6. }

然后就可以通过http://localhost/swagger-ui.html看到项目中所有的接口信息了,通过http://localhost/v2/api-docs就能看到json数据。

转载请标明出处:http://blog.csdn.net/goldenfish1919/article/details/78280051

但是,如何在生产环境禁用这些api文档呢?试了很多种方式,最终找到一个简单实用的办法:

  1. @Configuration
  2. @EnableSwagger2
  3. @EnableWebMvc
  4. @ComponentScan("com.XXX.controller")
  5. public class SwaggerConfig{
  6. @Autowired
  7. ConfigService configService;
  8. @Bean
  9. public Docket customDocket() {
  10. if(configService.getServerEnv() == ServerEnvEnum.ONLINE) {
  11. return new Docket(DocumentationType.SWAGGER_2)
  12. .apiInfo(apiInfoOnline())
  13. .select()
  14. .paths(PathSelectors.none())//如果是线上环境,添加路径过滤,设置为全部都不符合
  15. .build();
  16. }else {
  17. return new Docket(DocumentationType.SWAGGER_2)
  18. .apiInfo(apiInfo());
  19. }
  20. }
  21. private ApiInfo apiInfo() {
  22. return new ApiInfoBuilder()
  23. .title("XXX系统")
  24. .description("XXX系统接口")
  25. .license("")
  26. .licenseUrl("")
  27. .termsOfServiceUrl("")
  28. .version("1.0.0")
  29. .contact(new Contact("","", ""))
  30. .build();
  31. }
  32. private ApiInfo apiInfoOnline() {
  33. return new ApiInfoBuilder()
  34. .title("")
  35. .description("")
  36. .license("")
  37. .licenseUrl("")
  38. .termsOfServiceUrl("")
  39. .version("")
  40. .contact(new Contact("","", ""))
  41. .build();
  42. }
  43. }
  44. 参考:http://blog.csdn.net/w4hechuan2009/article/details/68892718

    swagger必须要跟springmvc在同一个context才行,springmvc只是spring的一个子context。如果swagger让spring的context加载,那么swagger的那些url用springmvc的拦截器是拦截不到的!

    所以,两种解决办法:

    如果是使用注解的方式:

    (1)spring-mvc的配置:

    1. <!-- 使用Annotation自动注册Bean,只扫描@Controller -->
    2. <context:component-scan base-package="com.inspur.eyun.yunbx" use-default-filters="false"><!-- base-package 如果多个,用“,”分隔 -->
    3. <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    4. <context:include-filter type="assignable" expression="com.inspur.eyun.yunbx.swagger.SwaggerConfig"/>
    5. </context:component-scan>

    注意要把swagger的配置加进来,同时:

    (2)spring的配置:

    1. <!-- 包扫描、注解相关 -->
    2. <context:component-scan base-package="com.inspur.eyun.yunbx">
    3. <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    4. <context:exclude-filter type="assignable" expression="com.inspur.eyun.yunbx.swagger.SwaggerConfig"/>
    5. </context:component-scan>

    注意把swagger排除掉

    (3)Swagger的配置:

    1. @Configuration
    2. @EnableSwagger2
    3. @EnableWebMvc
    4. @ComponentScan("com.inspur.eyun.yunbx.controller")
    5. public class SwaggerConfig{
    6. }

    注意@Configuration注解。

    当然更推荐的办法是使用xml配置的方式,因为这样可以不用引入swagger的依赖包:

    (1)spring-mvc的配置:

    1. <!-- 使用Annotation自动注册Bean,只扫描@Controller -->
    2. <context:component-scan base-package="com.inspur.eyun.yunbx" use-default-filters="false"><!-- base-package 如果多个,用“,”分隔 -->
    3. <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    4. </context:component-scan>
    5. <import resource="classpath:spring-mvc-swagger.xml" />

    spring-mvc-swagger.xml:

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <beans xmlns="http://www.springframework.org/schema/beans"
    3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    4. xsi:schemaLocation="
    5. http://www.springframework.org/schema/beans
    6. http://www.springframework.org/schema/beans/spring-beans.xsd">
    7. <description>SpringMVC Swagger Configuration</description>
    8. <!-- swagger配置,生产环境置空 -->
    9. <bean class="com.inspur.eyun.yunbx.swagger.SwaggerConfig" />
    10. </beans>

    注意:我们这里把swagger单独放到一个配置文件中,如果是线上环境,则文件内容为空,如果是线下测试环境,则配置上Swagger。

    (2)spring的配置:

    1. <!-- 包扫描、注解相关 -->
    2. <context:component-scan base-package="com.inspur.eyun.yunbx">
    3. <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    4. </context:component-scan>

    (3)Swagger的配置:

    1. @EnableSwagger2
    2. @EnableWebMvc
    3. public class SwaggerConfig{
    4. @Bean
    5. public Docket customDocket() {
    6. return new Docket(DocumentationType.SWAGGER_2)
    7. .apiInfo(apiInfo())
    8. .select()
    9. .apis(RequestHandlerSelectors.basePackage("com.inspur.eyun.yunbx.controller"))
    10. .paths(PathSelectors.any())
    11. .build();
    12. }
    13. private ApiInfo apiInfo() {
    14. return new ApiInfoBuilder()
    15. .title("XXX平台")
    16. .description("XXX平台接口")
    17. .license("")
    18. .licenseUrl("")
    19. .termsOfServiceUrl("")
    20. .version("1.0.0")
    21. .contact(new Contact("","", ""))
    22. .build();
    23. }
    24. }

    注意:这里我们去掉了@Configuration,同时,修改我们的pom,配置多profile打包:

    pom.xml:

    1. <!-- Swagger -->
    2. <dependency>
    3. <groupId>io.springfox</groupId>
    4. <artifactId>springfox-swagger2</artifactId>
    5. <version>${springfox-swagger.version}</version>
    6. <scope>${swagger.scope}</scope>
    7. </dependency>
    8. <dependency>
    9. <groupId>io.springfox</groupId>
    10. <artifactId>springfox-swagger-ui</artifactId>
    11. <scope>${swagger.scope}</scope>
    12. <version>${springfox-swagger-ui.version}</version>
    13. </dependency>

    注意:这里的依赖的scope是动态设置的,如果是线上环境,我们把scope设置成provided就可以。

    1. <profiles>
    2. <profile>
    3. <id>dev</id>
    4. <properties>
    5. <profiles.active>dev</profiles.active>
    6. <swagger.scope>compile</swagger.scope>
    7. </properties>
    8. <activation>
    9. <activeByDefault>true</activeByDefault>
    10. </activation>
    11. </profile>
    12. <profile>
    13. <id>test</id>
    14. <properties>
    15. <profiles.active>test</profiles.active>
    16. <swagger.scope>compile</swagger.scope>
    17. </properties>
    18. </profile>
    19. <profile>
    20. <id>online</id>
    21. <properties>
    22. <profiles.active>online</profiles.active>
    23. <swagger.scope>provided</swagger.scope>
    24. </properties>
    25. </profile>
    26. </profiles>

    通过不同的profile给swagger的依赖设置不同的scope!

    注意:springfox-swagger.version=2.7.0有bug,可以使用低版本2.6.1。太他妈的坑!

如何在生产环境禁用swagger的更多相关文章

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

    前言 Swagger使用起来简单方便,几乎所有的API接口文档都采用swagger了.使用示例:http://www.cnblogs.com/woshimrf/p/swagger.html, 现在开发 ...

  2. 生产环境屏蔽swagger(动态组装bean)

    spring动态组装bean 背景介绍: 整合swagger时需要在生产环境中屏蔽掉swagger的地址,不能在生产环境使用 解决方案 使用动态profile在生产环境中不注入swagger的bean ...

  3. 在生产环境下禁用swagger

    学习目标 快速学会使用注解关闭Swagger2,避免接口重复暴露. 使用教程 禁用方法1:使用注解@Profile({"dev","test"}) 表示在开发或 ...

  4. SpringBoot 通过配置禁用swagger

    转自:https://blog.csdn.net/weixin_37264997/article/details/82762050 一.序言 在生产环境下,我们需要关闭swagger配置,避免暴露接口 ...

  5. 【简记】SpringBoot禁用Swagger

    楔子 Swagger 是 Java Web 开发中常用的接口文档生成类库,在开发和前后端联调时使用它来模拟接口调用能提高开发效率.但是,在生产环境可能并不需要它,一个原因是启用它会延长程序启动时间(动 ...

  6. Greenplum 数据库安装部署(生产环境)

    Greenplum 数据库安装部署(生产环境) 硬件配置: 16 台 IBM X3650, 节点配置:CPU 2 * 8core,内存 128GB,硬盘 16 * 900GB,万兆网卡. 万兆交换机. ...

  7. [译]MongoDb生产环境注意事项

    译注: 本文是翻译MongoDB Manuel中的MongoDB Production Notes一节内容.这节内容重点关注生产环境中影响性能和可靠性的各种注意事项,值得正在部署MongoDB的工作者 ...

  8. 【转】生产环境MySQL Server核心参数的配置

         ⑴ lower_case_table_names              ● 推荐理由                    GNU/Linux 平台,对数据库.表.存储过程等对象名称大小 ...

  9. MongoDB 生产环境笔记

    目录 MongoDB 生产环境笔记 一.vm.zone_reclaim_mode 参数 二.添加 swap 分区 三.设置 swappiness 参数 四.内核和文件系统版本 五.禁用 Transpa ...

随机推荐

  1. 拒绝“高冷”词汇!初学C#中的委托

    有一天,你写了好多好多带“形参”的构造函数(就是“方法”,同义),而且需要向这些构造函数里传递同样的“实参”,然后你就憨憨地一个一个函数的调用并赋予同样的“实参”,这一天就这么过去了... 又过了几天 ...

  2. Keil下Debug随笔

    很多时候我们需要通过硬件仿真来调试程序,在仿真时有时候会遇到这样的情况,那就是选择全速运行时,我们的全局变量无法随时更新,而在那设一个断点后发现值是变化的,那么为什么会出现这种情况呢,那就是可能是我们 ...

  3. Docker容器的原理与实践(上)

    本文来自网易云社区. 虚拟化 是一种资源管理技术,将计算机的各种资源予以抽象.转换后呈现出来, 打破实体结构间的不可切割的障碍,使用户可以比原本更好的方式来应用这些资源. Hypervisor 一种运 ...

  4. 《Python绝技:运用Python成为顶级黑客》 用Python分析网络流量

    1.IP流量将何去何从?——用Python回答: 使用PyGeoIP关联IP地址和物理地址: 需要下载安装pygeoip,可以pip install pygeoip 或者到Github上下载安装htt ...

  5. 双向链表的实现——c++

    c++实现双向链表 : #ifndef DOUBLE_LINK_HXX #define DOUBLE_LINK_HXX #include <iostream> using namespac ...

  6. tomcat 项目发布方式

    1.WEB应用的组成结构 开发web应用时,不同类型的文件有严格的存放规则,否则不仅会使web应用无法访问 还会导致web服务器自动报错. mail:web应用所在目录(该目录自定义) html,js ...

  7. 为什么子元素设置margin-top会作用在父元素上?

    原因在于:CSS 外边距合并 复现: <!DOCTYPE html> <html lang="en"> <head> <meta char ...

  8. 使用browserSync自动刷新

    本篇主要是以 http://www.imooc.com/article/14759 为参考来写的: 已经整理到github上:https://github.com/Macaulish/gulp-Bro ...

  9. Java并发编程之volatile的应用

    在多线程的并发编程中synchronized和volatile都扮演着重要的角色.volatile是轻量级的synchronized,它在多处理器的开发中保证了共享变量的可见性,可见性的意思是当一个线 ...

  10. node 本地静态服务器

    直接上代码 const connect = require("connect"); const serveStatic = require("serve-static&q ...