swagger-bootstrap-ui 介绍和使用
参考：
https://doc.xiaominfo.com/guide/useful.html
UI特点
- 以markdown形式展示文档,将文档的请求地址、类型、请求参数、示例、响应参数分层次依次展示,接口文档一目了然,方便开发者对接
- 在线调试栏除了自动解析参数外,针对必填项着颜色区分,同时支持tab键快速输入上下切换.调试时可自定义Content-Type请求头类型
- 个性化配置项,支持接口地址、接口description属性、UI增强等个性化配置功能
- 接口排序,支持分组及接口的排序功能
- 支持markdown文档离线文档导出,也可在线查看离线文档
- 调试信息全局缓存,页面刷新后依然存在,方便开发者调试
- 以更人性化的treetable组件展示Swagger Models功能
- 响应内容可全屏查看,针对响应内容很多的情况下，全屏查看，方便调试、复制
- 文档以多tab方式可显示多个接口文档
- 请求参数栏请求类型、是否必填着颜色区分
- 主页中粗略统计接口不同类型数量
- 支持接口在线搜索功能
- 左右菜单和内容页可自由拖动宽度
- 支持自定义全局参数功能，主页包括header及query两种类型
- i18n国际化支持,目前支持：中文简体、中文繁体、英文
- JSR-303 annotations 注解的支持
快速开始
java开发
如果你是一名Java开发工程师,那么使用swagger-bootstrap-ui将会非常简单,只需要在原使用的基础上,添加swagger-bootstrap-ui的maven引用jar包即可
Maven中引入Jar包
由于是springfox-swagger的增强UI包,所以基础功能依然依赖Swagger,springfox-swagger的jar包必须引入
<dependency>
<groupId>io.springfoxgroupId>
<artifactId>springfox-swagger2artifactId>
<version>2.9.2version>
dependency>
然后引入SwaggerBootstrapUi的jar包
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>${lastVersion}</version>
</dependency>
1.9.6
编写Swagger2Config配置文件
Swagger2Config配置文件如下：
@Configuration
@EnableSwagger2
public class SwaggerConfiguration {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.bycdao.cloud"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("swagger-bootstrap-ui RESTful APIs")
.description("swagger-bootstrap-ui")
.termsOfServiceUrl("http://localhost:8999/")
.contact("[email protected]")
.version("1.0")
.build();
}
}
访问地址
swagger-bootstrap-ui默认访问地址是：http://${host}:${port}/doc.html
注意事项
Springfox-swagger默认提供了两个Swagger接口,需要开发者放开权限(如果使用shiro权限控制框架等)，如果使用SwaggerBootstrapUi的增强功能,还需放开增强接口地址,所以，放开的权限接口包括3个，分别是：
/swagger-resources:Swagger的分组接口/v2/api-docs?group=groupName:Swagger的具体分组实例接口,返回该分组下所有接口相关的Swagger信息/v2/api-docs-ext?group=groupName:该接口是SwaggerBootstrapUi提供的增强接口地址,如不使用UI增强,则可以忽略该接口
Shiro 的相关配置实例如下：
<property name="filterChainDefinitions">
<value>
/swagger-resources = anon
/v2/api-docs = anon
/v2/api-docs-ext = anon
/doc.html = anon
/webjars/** = anon
//others....
value>
property>
SpringBoot 中访问 doc.html 报404的解决办法
实现SpringBoot的WebMvcConfigurer接口，添加相关的ResourceHandler,代码如下：
@SpringBootApplication
@ConditionalOnClass(SpringfoxWebMvcConfiguration.class)
public class SwaggerBootstrapUiDemoApplication implements WebMvcConfigurer{
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
使用SpringMvc的朋友.在 web.xml 中配置了DispatcherServlet,则需要追加一个url匹配规则,如下（cmsMvc 为 DispatcherServlet 的定义名）
<servlet>
<servlet-name>cmsMvcservlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class>
<init-param>
<param-name>contextConfigLocationparam-name>
<param-value>classpath:config/spring.xmlparam-value>
init-param>
<load-on-startup>1load-on-startup>
servlet>
<servlet-mapping>
<servlet-name>cmsMvcservlet-name>
<url-pattern>*.htmurl-pattern>
servlet-mapping>
<servlet-mapping>
<servlet-name>cmsMvcservlet-name>
<url-pattern>/v2/api-docsurl-pattern>
servlet-mapping>
<servlet-mapping>
<servlet-name>cmsMvcservlet-name>
<url-pattern>/swagger-resourcesurl-pattern>
servlet-mapping>
<servlet-mapping>
<servlet-name>cmsMvcservlet-name>
<url-pattern>/v2/api-docs-exturl-pattern>
servlet-mapping>
更名knife4j
一开始项目初衷是为了写一个增强版本的Swagger 前端UI,但是随着项目的发展,面对越来越多的个性化需求,不得不编写后端Java代码以满足新的需求,在swagger-bootstrap-ui的1.8.5~1.9.6版本之间,采用的是后端Java代码和Ui都混合在一个Jar包里面的方式提供给开发者使用.这种方式虽说对于集成swagger来说很方便,只需要引入jar包即可,但是在微服务架构下显得有些臃肿。
因此,项目正式更名为knife4j,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍,更名也是希望把她做成一个为Swagger接口文档服务的通用性解决方案,不仅仅只是专注于前端Ui前端.
swagger-bootstrap-ui的所有特性都会集中在knife4j-spring-ui包中,并且后续也会满足开发者更多的个性化需求.
主要的变化是,项目的相关类包路径更换为com.github.xiaoymin.knife4j前缀,开发者使用增强注解时需要替换包路径
后端Java代码和ui包分离为多个模块的jar包,以面对在目前微服务架构下,更加方便的使用增强文档注解(使用SpringCloud微服务项目,只需要在网关层集成UI的jar包即可,因此分离前后端)
knife4j沿用swagger-bootstrap-ui的版本号,第1个版本从1.9.6开始,关于使用方法,请参考文档
knife4j目前的项目结构
|-knife4j
|-----knife4j-annotations // 提供的增强注解包
|-----knife4j-core // 相关业务逻辑核心包
|-----knife4j-spring //spring项目使用swagger是可以直接使用该jar包
|-----knife4j-spring-ui // swagger前端ui文档,访问方式不变,还是doc.html
|-----knife4j-spring-boot-starter //knife4j为Spring Boot项目提供的starter组件
不同项目场景下如何从swagger-bootsstrap-ui切换使用knife4j
Spring Boot单服务架构
如果你是Spring Boot的单体架构,所有的服务Controller接口都是写在一起的,那么使用knife4j的方式就很简单了,你只需要引入starter即可
maven中的pom.xml文件引入starter即可
<dependency>
<groupId>com.github.xiaoymingroupId>
<artifactId>knife4j-spring-boot-starterartifactId>
<version>2.0.1version>
dependency>
knife4j-spring-boot-starter主要为我们引用的相关jar包：
knife4j-spring:Swagger增强处理类knife4j-spring-ui:swagger的增强ui文档springfox-swagger:springfox最新2.9.2版本springfox-swagger-ui:springfox提供的uispringfox-bean-validators：springfxo 验证支持组件
此时,位于包路径com.github.xiaoymin.knife4j.spring.configuration.Knife4jAutoConfiguration.java类会为我们开启Swagger的增强注解,您只需要在项目中创建Swagger的Docket对象即可
@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfiguration {
}
Spring Cloud微服务架构
在微服务架构下,引入微服务的starter
<dependency>
<groupId>com.github.xiaoymingroupId>
<artifactId>knife4j-micro-spring-boot-starterartifactId>
<version>2.0.1version>
dependency>
knife4j-micro-spring-boot-starter 的区别在于去掉了Swagger的前端UI包,只引入了后端的Java代码模块
主要包含的核心模块jar：
knife4j-spring:Swagger增强处理类springfox-swagger:springfox最新2.9.2版本springfox-bean-validators：springfxo验证支持组件