,通常有时候我们碰到的问题如下:
针对以上两种情况,SwaggerBootstrapUi在1.9.0的版本中加入了过滤Filter功能,如果开发者使用SpringBoot开发框架进行开发的话,只需在application.properties
或者application.yml
配置文件中配置相关属性即可方便的解决上面的问题,不用删除Springfox-swagger的jar包或者删除相关代码等复杂的操作,提升开发体验.
目前Springfox-Swagger
以及SwaggerBootstrapUi
提供的资源接口包括如下:
当我们部署系统到生产系统,为了接口安全,需要屏蔽所有Swagger的相关资源
如果使用SpringBoot框架,只需在或者application.yml
配置文件中配置
效果图如下:
访问页面加权控制
不管是官方的swagger-ui.html
或者doc.html
,目前接口访问都是无需权限即可访问接口文档的,很多朋友以前问我能不能提供一个登陆界面的功能,开发者输入用户名和密码来控制界面的访问,只有知道用户名和密码的人才能访问此文档
做登录页控制需要有用户的概念,所以相当长一段时间都没有提供此功能
不过在1.9.0
版本时,针对Swagger的资源接口,提供了简单的Basic认证功能
允许开发者在配置文件中配置一个静态的用户名和密码,当对接者访问Swagger页面时,输入此配置的用户名和密码后才能访问Swagger文档页面,如果您使用SpringBoot开发,则只需在相应的application.properties
或者application.yml
中配置如下:
如果用户开启了basic认证功能,但是并未配置用户名及密码,SwaggerBootstrapUi
提供了默认的用户名和密码:
如果您使用的是SpringMVC
,则需要在中添加相应的Filter,参考如下:
ProductionSecurityFilter和只需配置一个即可
SecurityBasicAuthFilter:开启HTTP Basic认证,访问Swagger资源需要提供服务端配置的用户名以及密码