一、介绍
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案（在非Java项目中也提供了前端UI的增强解决方案），前身是swagger-bootstrap-ui,取名knifeQ L E A S 7 k Z %4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!
二、开源仓库
- Github
https://github.com/xiaoymin/swagger-bootstrap-ui- 码云
https://gitee.com/xiaoym/knife4j三、功能特性
- 简洁
基于左右菜单式的@ 1 -布局方式,是更符合国人的操作习惯吧.文档更清晰...
- 个性化配置
个性化配置项,支持接口地址] 9 0 = ! H * 2 U、接口description属性、UI增强等个性化配置功i L I M能...
- 增强
接口排序、Swagger资源保护、导出Markdown、参数缓存众多强大功能...
四、功能预览
- 在线预览
http://knife4j.xiaominfo.com/doc.html- 选择不同接口
- Autho0 u &rize
- swagger实体
包含了swagger实体的相x ! j E W关信息
- swagA 3 j ) 6 p K - mger全局设置
全局参数设置
- 离线文档导P r s 3 g %出
Knife4j提供导出4种格式的离线文档(Html\\Markdown\\Wo` ( Q # r $ c ?rd\\Pdf)
- 个性化设置
- api文档
- 搜索功能
五、使用简介
- 项目结构 / 3 A y c Y ;
- 目8 d w E前主要的模块
目前主要的模块包括：模9 v k 4 G F 0 _ G块名称说明：kn9 l 6 rife4j为Java MVC框架集成Swagger的增强解决方案knife4j-admi= b u _ Un云端Swagger接口文档注册管理中心,集` 6 k o成gateway网关G U _ j . V + O对任$ 0 ; j # F意微T S 3 k - [ j u q服务文档进行组合集成knife4j-extensionchrome浏览器的增强swagger接口文档ui,快速渲染swagger资源knife4j-service为swag C g 9 Gger服务的一系列接口服务程序knife4j-frontknB v [ G ! / 1 [ife4j-spril 3 u L ng-ui的纯前端静态版本,用于集成非Java语言使用sp N 3 K L ` = h pwagger-bootstrap-uiknife4j的前身,最后发布版本是1.9.6- 单纯皮肤增强
不使用增强功能,纯粹换一个swagger的前端皮肤，这种情况是最r 7 ^ T s F $ 5简单的,你项目结构下无需变更
可以直接引用swagger-bootstrap-ui的最后一个版本1.9.6或者使用knife4j-spring-ui
老版本引用
&S $ i xlt;dependency> i g L
<groupId>com.github.xiaol m S { . : l b wymin</groupId>
d 2 { - <artifactId>swagger-bootstrap-ui</artifactId> 8 , $ 2;
&) 2 u G ^ Gnbsp;<version>1.9.6<, S x K p n E;/version>
</dependq ] w J & xency>新版本引; _ ] 9 P m v用
<! [ H;dependency>
<groupId>com.github.xiaoymin</groupId> v ; z @ # Z y D l;
<artifactId>knife4j-spring-ui</artifactId>y Q / Z L c 8 | !
&nbsM % % ! m Ap; <version>${lastVersion}</versJ f G ! 0 Zion>
</dependency>- SQ q c = ( 6 S g dpring Boot项目单体架构使用增强功能
在Spring Boot单体架) ] 0 c Q构下,knife4j提供了starter供开发者快速使用
<dependency> S d j j ;
<groupId>com.github.xiaoymin</groupId>&% = * ; % Pnbsp; &nP , 2 , 9 mbsp;
<art: G J Q [ | l 6ifactId>knife4j-] W nspring-boot-starter</artifactId>&nbZ vsp; &4 k Hnbsp;
<version>${knife4j.version}</version>
</dependency>该包会引用所有的r 4 ?knife4j提供的资源，包括前端Ui的jar包
- Spring Cloud微服务架构
在Spring Cloud的微服务架构下,每个微服务其实并不需要引入前端) O f ; S o的Ui资源,因此在每个微服务的Spring Boot项目下,引入knife4j提供的微服务s8 w 4 B N Ntarter
<dependenc8 ? % Fy>
&nL . S wbsp;&} $ U 8 u Clt;groupId>com.github.U l o % 1 o E | ^xiaoymin</grou` x r ( E fpId= + .> , v , x;&nbN ? ! }sp;
<aI W @ L 7 ^rtifactId>8 H Y H ~ T F;knife4j-micm R ( s iro-spring-boot0 f , n-starter</artifactId> &O | M vnbsp;&nbsY a + qp? o F 3 };
<= J ! p;version>${knife4j.version}</version>
</dependency>在网关聚合文档服务下,可以再把前端的ui资源引( , q ;入
<dependency>&nh ] ) r ] @ Dbsp;&nbs6 / i { ( + W {p/ _ ( m E C;
<groupId&S V 3 / sgt;com.github.xi T / L , )aoymin</groupId> &n8 _ H 6 Q ~ ^ q hbsp;
<G 5 D V . ] & EartifactId&g$ u ^ Ot;knife4j-spring-boot-starter</artifactId>
&. _ O fnbsp( 1 d k I M u w p;<veJ 6 h # N ) { & krsion>${knife4j.version}</version>
</dependency>六、总结
针对knife4j的总结，无非就是牛逼来形容，切实的解决了swagger ui不够友好的问题，而且还可以集成到其他语言的api项目中，真真切切的需要感谢开发作~ f $ ] g Z @ 者提供了这么好的工具6 i o r ? u 2 +供我们使用，小伙伴是不是心动了，赶紧去试试吧！enjoy it！