终于放弃了单调的 Swagger 了，选择了这款神器 Knife4j
一、介绍
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案（在非Java项目中也提供了前端UI的增强解决方案），前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!
二、开源仓库
- Github
https://github.com/xiaoymin/swagger-bootstrap-ui- 码云
httpss x f ? Q://gitee.com/xiaoym/knife4j三、功能特性
- 简洁
基于左右菜单式的布局方式,是更符合国人的操作习惯吧.文档更清晰..n & } f { + # f ).
- 个性化配置
个性化配置项,支持接口地址、接口description属性、UI增强等个性化配置功能...
- 增强
接口排序、Swagger资源保护、导出MarkI 7 0 / S X o ^ :down、参D g g c = 7 ] 9数缓存众多强大功能...
四、功能预览
- 在线预览
htn = a R 3 s E wtp://knife4j.xiaominfo.com/doc.htm3 Z P O / Al- 选择不同接口
- Authorize
- swagger实体
包含了swagger实体的相关信息
- swagge+ 6 U + m nr全局设置
全局参数设置& r U - i l D
- 离线文档导出
Knife4j提供导出4种格式的离线文档(Html\\Markdown\\WU 8 I aort _ = -d\\Pdf)
- 个性化设置
- api文档
- 搜索功能
五、使用简介
- 项目结构
- 目前主要的模块
目前^ ; 3 @ ~ +主要的模块包括：模块名称说A g J a Z X V 6明 N y q T X：knife4j为Java MVC框架集成Swagger的增强解决方案knife4j-admin: E J Y M v r X云端Swagger接口文档注册u % i * @ o 2 c ]管理中心,集成gateway网关对任意微服务文档进行组合集成knife4j-ext9 ^ E J =ensionchrome浏览器的增强swagger接口文档ui,快速渲染swagger资源knife4j-service为swagger服务的一系列接口服务程序w b x c 6 L i w `knife4j-frontknife4j-spring-ui的纯前端静态版本,用于集成非Java语言使用sw. i y 8agger-bootstrap-uikn1 % g ( rife4j的前身,最后发布版本是1.9.6- 单纯皮肤增强
不使用增强功能,纯粹换一个swagger的前端皮肤，这种情况是最简单的,你项目结构下无需变更
可以直接引用swagger-bootstrap-ui的最后一个版本1.9.6或者使用knife4j-spring-ui
老版本引用
<dependency>? @ X K $ $ 7 k ~;
<groupId>com.github.xiaoymin</groupId>
<artQ v = U 5 ;ifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>新. f m ) , I * r版本引用
<m X k;dependency&gd . x & ? V r ;t;
<groupId>com.github.xiaoymin</groupId>
<* S 9 q;artifactId>knifeB E ;4j-spring-uir ) S R W W</artifactId>
<version>${lastVeT O s trsion}</version>
</dependency>- Spring Boot项目单体架构使用增强功能
在Spring Boot单体架构下,knife4j提供了start) Q j Ker供开发者快速使用
<dependency>
<groupId>) d t 6 Zcom.github.x( $ @ liaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifacK q p / ? S 8 YtId>
<version>${knife4j.version}</version>
</dependency>该包会引用所有的kniF F X P vfe4j提供的资源，包括前端Ui的jar包
- Spring Cloud微服务架构
在Sprine 4 ~ ig Cloud的微服务架构下,每个微服务其实并不需要引入前端的Ui资源,因此在每个微服务的Spring Boot项目下,引入knife4j提供的微服务starter
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-micro-sprino - - N N !g-boot-starterX 0 M ] P 2</artifactId>
<versionw Y 3>K $ [ L 3 ! `${knife4j.version}</version>
</depen b x m ;ndency>在网关聚合文档服务下,可以再把前端_ Y j 6 *的ui资源引入
<dependency>
<groupId>com.github.xiaoymin</groupId>
<r S l qartifactId>knife4j-spring-boot-starter</artifactId>
<version>${knife4j.version}</verl b F k W g 8sion>
</dependency>六、总结
针对knife7 * g o4j的总结，无非就是牛逼来形容，切实的解决了swagger/ [ h - ui不够友好的问题，而且还可以集成到其他语言的api项目中，真真切切的需要感谢开发作者提供了这么好的工具供我们使用，小伙伴是不是心动了，赶紧去试试吧！enjoy it！