在开发SwaggerBootstrapUi功能时,同很多开发者经常讨论的问题就是在生产环境时,屏蔽或者去除Swagger的文档很麻烦

,通常有时候我们碰到的问题如下:

  • 系统部署生产环境时,我们想屏蔽Swagger的文档功能,不管是接口或者html文档
  • 通常我们有时候需要生产环境部署后,又需要Swagger的文档调试功能,辅助开发者调试,但是存在安全隐患,没有对Swagger的资源接口过滤
  • 等等

针对以上两种情况,SwaggerBootstrapUi在1.9.0的版本中加入了过滤Filter功能,如果开发者使用SpringBoot开发框架进行开发的话,只需在application.properties或者application.yml配置文件中配置相关属性即可方便的解决上面的问题,不用删除Springfox-swagger的jar包或者删除相关代码等复杂的操作,提升开发体验.

开启生产环境,屏蔽Swagger所有资源接口

目前Springfox-Swagger以及SwaggerBootstrapUi提供的资源接口包括如下:

资源 说明
/doc.html SwaggerBootstrapUi提供的文档访问地址
/api-docs-ext SwaggerBootstrapUi提供的增强接口地址
/swagger-resources Springfox-Swagger提供的分组接口
/api-docs Springfox-Swagger提供的分组实例详情接口
/swagger-ui.html Springfox-Swagger提供的文档访问地址
/swagger-resources/configuration/ui Springfox-Swagger提供
/swagger-resources/configuration/security Springfox-Swagger提供

当我们部署系统到生产系统,为了接口安全,需要屏蔽所有Swagger的相关资源

如果使用SpringBoot框架,只需在application.properties或者application.yml配置文件中配置

  1. swagger.production=true

配置此属性后,所有资源都会屏蔽输出.

效果图如下:

访问权限控制 - 图1

访问页面加权控制

不管是官方的swagger-ui.html或者doc.html,目前接口访问都是无需权限即可访问接口文档的,很多朋友以前问我能不能提供一个登陆界面的功能,开发者输入用户名和密码来控制界面的访问,只有知道用户名和密码的人才能访问此文档

做登录页控制需要有用户的概念,所以相当长一段时间都没有提供此功能

不过在1.9.0版本时,针对Swagger的资源接口,SwaggerBootstrapUi提供了简单的Basic认证功能

效果图如下:

访问权限控制 - 图2

允许开发者在配置文件中配置一个静态的用户名和密码,当对接者访问Swagger页面时,输入此配置的用户名和密码后才能访问Swagger文档页面,如果您使用SpringBoot开发,则只需在相应的application.properties或者application.yml中配置如下:

  1. ## 开启Swagger的Basic认证功能,默认是false
  2. swagger.basic.enable=true
  3. ## Basic认证用户名
  4. swagger.basic.username=zhangsan
  5. ## Basic认证密码
  6. swagger.basic.password=123

如果用户开启了basic认证功能,但是并未配置用户名及密码,SwaggerBootstrapUi提供了默认的用户名和密码:

  1. admin/123321

如果您使用的是SpringMVC,则需要在web.xml中添加相应的Filter,参考如下:

  1. <!--SwaggerBootstrapUi提供的Swagger增强功能,Filter过滤保护Swagger资源-->
  2. <!--生产环境Filter-->
  3. <filter>
  4. <filter-name>swaggerProductionFilter</filter-name>
  5. <filter-class>com.github.xiaoymin.swaggerbootstrapui.filter.ProductionSecurityFilter</filter-class>
  6. <init-param>
  7. <param-name>production</param-name>
  8. <param-value>false</param-value>
  9. </init-param>
  10. </filter>
  11. <filter-mapping>
  12. <filter-name>swaggerProductionFilter</filter-name>
  13. <url-pattern>/*</url-pattern>
  14. </filter-mapping>
  15. <!--Swagger资源的Basic认证保护策略-->
  16. <filter>
  17. <filter-name>swaggerSecurityBasic</filter-name>
  18. <filter-class>com.github.xiaoymin.swaggerbootstrapui.filter.SecurityBasicAuthFilter</filter-class>
  19. <!--开启basic认证-->
  20. <init-param>
  21. <param-name>enableBasicAuth</param-name>
  22. <param-value>true</param-value>
  23. </init-param>
  24. <!--用户名&密码-->
  25. <init-param>
  26. <param-name>userName</param-name>
  27. <param-value>lisi</param-value>
  28. </init-param>
  29. <init-param>
  30. <param-name>password</param-name>
  31. <param-value>123</param-value>
  32. </init-param>
  33. </filter>
  34. <filter-mapping>
  35. <filter-name>swaggerSecurityBasic</filter-name>
  36. <url-pattern>/*</url-pattern>
  37. </filter-mapping>

ProductionSecurityFilterSecurityBasicAuthFilter只需配置一个即可

ProductionSecurityFilter:开启生产环境,屏蔽所有Swagger资源,不可访问,production配置为true时,basic认证功能不可用

SecurityBasicAuthFilter:开启HTTP Basic认证,访问Swagger资源需要提供服务端配置的用户名以及密码