界面美观功能强大，终于可以告别单调的 Swagger 了

逃离我推掉我的手 2021-08-26 11:26 280阅读 0赞

![format_png][]

作者 | 最美分享Coder

链接 | toutiao.com/i6789135368064074253

knife4j 是为Java MVC框架集成 Swagger 生成 Api 文档的增强解决方案（在非Java项目中也提供了前端UI的增强解决方案），前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!

![format_png 1][]

--------------------

*  Github

https://github.com/xiaoymin/swagger-bootstrap-ui

*  码云

https://gitee.com/xiaoym/knife4j

*  **简洁**

基于左右菜单式的布局方式,是更符合国人的操作习惯吧.文档更清晰...

*  **个性化配置**

个性化配置项,支持接口地址、接口description属性、UI增强等个性化配置功能...

*  **增强**

接口排序、Swagger资源保护、导出Markdown、参数缓存众多强大功能...

*  在线预览

http://knife4j.xiaominfo.com/doc.html

*  选择不同接口

![format_png 2][]

*  Authorize

![format_png 3][]

*  swagger实体

包含了swagger实体的相关信息

![format_png 4][]

*  swagger全局设置

全局参数设置

![format_png 5][]

![format_png 6][]

*  离线文档导出

Knife4j提供导出4种格式的离线文档(Html\\Markdown\\Word\\Pdf)

![format_png 7][]

*  个性化设置

![format_png 8][]

*  api文档

![format_png 9][]

![format_png 10][]

*  搜索功能

![format_png 11][]

*  项目结构

![format_png 12][]

*  目前主要的模块

目前主要的模块包括：模块名称说明：knife4j为Java MVC框架集成Swagger的增强解决方案knife4j-admin云端Swagger接口文档注册管理中心,集成gateway网关对任意微服务文档进行组合集成knife4j-extensionchrome浏览器的增强swagger接口文档ui,快速渲染swagger资源knife4j-service为swagger服务的一系列接口服务程序knife4j-frontknife4j-spring-ui的纯前端静态版本,用于集成非Java语言使用swagger-bootstrap-uiknife4j的前身,最后发布版本是1.9.6

*  单纯皮肤增强

不使用增强功能,纯粹换一个swagger的前端皮肤，这种情况是最简单的,你项目结构下无需变更

可以直接引用swagger-bootstrap-ui的最后一个版本1.9.6或者使用knife4j-spring-ui

老版本引用

<dependency>    
     <groupId>com.github.xiaoymin</groupId>    
     <artifactId>swagger-bootstrap-ui</artifactId>    
     <version>1.9.6</version>
    </dependency>

新版本引用

<dependency>    
     <groupId>com.github.xiaoymin</groupId>    
     <artifactId>knife4j-spring-ui</artifactId>    
     <version>${lastVersion}</version>
    </dependency>

*  Spring Boot项目单体架构使用增强功能

在Spring Boot单体架构下,knife4j提供了starter供开发者快速使用

<dependency>    <groupId>com.github.xiaoymin</groupId>    <artifactId>knife4j-spring-boot-starter</artifactId>    <version>${knife4j.version}</version></dependency>

该包会引用所有的knife4j提供的资源，包括前端Ui的jar包

*  Spring Cloud微服务架构

在Spring Cloud的微服务架构下,每个微服务其实并不需要引入前端的Ui资源,因此在每个微服务的Spring Boot项目下,引入knife4j提供的微服务starter

<dependency>    
    <groupId>com.github.xiaoymin</groupId>   
    <artifactId>knife4j-micro-spring-boot-starter</artifactId>   
    <version>${knife4j.version}</version>
    </dependency>

在网关聚合文档服务下,可以再把前端的ui资源引入

<dependency>    
    <groupId>com.github.xiaoymin</groupId>   
    <artifactId>knife4j-spring-boot-starter</artifactId>   
    <version>${knife4j.version}</version>
    </dependency>

针对knife4j的总结，无非就是牛逼来形容，切实的解决了swagger ui不够友好的问题，而且还可以集成到其他语言的api项目中，真真切切的需要感谢开发作者提供了这么好的工具供我们使用，小伙伴是不是心动了，赶紧去试试吧！enjoy it！

***有偿投稿：***欢迎投稿原创技术博文，一旦采用将给予 50元 - 200元 不等稿费， 要求个人原创，图文并茂。可以是职场经验、面试经历，也可是技术教程，学习笔记。投稿请联系微信「web527zsd」，备注投稿。

--------------------

\-END-

如果看到这里，说明你喜欢这篇文章，请**转发****、点赞**。微信搜索「web\_resource」，欢迎添加小编微信「focusoncode」，每日朋友圈更新一篇高质量技术博文（无广告）。

**↓扫描二维码添加小编↓**

![format_png 13][]

**推****荐****阅****读**

***1. ***[一张图帮你记忆：Spring Boot ][Spring Boot]

***2. ***[10 分钟实现 Java 发送邮件功能][10 _ Java]

***3.*** S[pring Boot 项目并发提升几倍][pring Boot]

***4. ***[Spring Boot 如何跨域请求][Spring Boot 1]

![format_png 14][]

[format_png]: /images/20210730/bafbea91ba1744739e9341b4142be301.png
[format_png 1]: /images/20210730/c4893aa230744f3db3cf39931c5d2021.png
[format_png 2]: /images/20210730/15b0c271ba634969aa02896ab56ba7e4.png
[format_png 3]: /images/20210730/0bb4ad5de3a042f9a43512b4c8d89985.png
[format_png 4]: /images/20210730/4f7148598d0d418c8bc4a2b2798e6057.png
[format_png 5]: /images/20210730/fd97050cf4db42f99009c273d5132031.png
[format_png 6]: /images/20210730/896eec1c6cc344bdaf039ab7536f55d8.png
[format_png 7]: /images/20210730/cae35c02515d465ca02c09bb7305fdf2.png
[format_png 8]: /images/20210730/213b95e38f6b45b69c44429efb1c3bc8.png
[format_png 9]: /images/20210730/58a141e19b514778b36882b0a9563df6.png
[format_png 10]: /images/20210730/7e4c5cc4aa8c486883919968e7fbbaab.png
[format_png 11]: /images/20210730/d029a84aa06442d2ba8aef43b4ce6338.png
[format_png 12]: /images/20210730/0fb071fe0b964e6b9e5a0c007bf1e0ee.png
[format_png 13]: /images/20210730/144f5c45235047028964bd621be85fee.png
[Spring Boot]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0e5634f979df22b7525e16a8192dfe3911a470e325497c37d2ff5c963b1974c232265b858d&idx=2&mid=2247492023&scene=21&sn=6080c2be4f05a708d0eba0077046d6f6#wechat_redirect
[10 _ Java]: https://blog.csdn.net/qq_37217713/article/details/104470973
[pring Boot]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0e5606f979df10889bae717586929c0b00fcec214705813c737a37d57011d2c6b5991bb8cf&idx=4&mid=2247491973&scene=21&sn=102c7514d24f9a3bb4c7b029ef5dd2e2#wechat_redirect
[Spring Boot 1]: https://blog.csdn.net/qq_37217713/article/details/104489402
[format_png 14]: /images/20210730/bfe61c1cd8dc413992a198c9811737a8.png