- 一、介绍
- 二、开源仓库
- 三、功能特性
- 四、功能预览
- 五、使用简介
- 六、总结
- 《Java 2019 超神之路》
- 《Dubbo 实现原理与源码解析 —— 精品合集》
- 《Spring 实现原理与源码解析 —— 精品合集》
- 《MyBatis 实现原理与源码解析 —— 精品合集》
- 《Spring MVC 实现原理与源码解析 —— 精品合集》
- 《Spring Boot 实现原理与源码解析 —— 精品合集》
- 《数据库实体设计合集》
- 《Java 面试题 —— 精品合集》
- 《Java 学习指南 —— 精品合集》
一、介绍
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案&＃xff08;在非Java项目中也提供了前端UI的增强解决方案&＃xff09;&＃xff0c;前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!
二、开源仓库
https://github.com/xiaoymin/swagger-bootstrap-ui
https://gitee.com/xiaoym/knife4j
三、功能特性
基于左右菜单式的布局方式,是更符合国人的操作习惯吧.文档更清晰...
个性化配置项,支持接口地址、接口description属性、UI增强等个性化配置功能...
接口排序、Swagger资源保护、导出Markdown、参数缓存众多强大功能...
四、功能预览
http://knife4j.xiaominfo.com/doc.html
包含了swagger实体的相关信息
全局参数设置
Knife4j提供导出4种格式的离线文档(HtmlMarkdownWordPdf)
五、使用简介
目前主要的模块包括&＃xff1a;模块名称说明&＃xff1a;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的前端皮肤&＃xff0c;这种情况是最简单的,你项目结构下无需变更
可以直接引用swagger-bootstrap-ui的最后一个版本1.9.6或者使用knife4j-spring-ui
老版本引用
com.github.xiaoyminswagger-bootstrap-ui1.9.6
新版本引用
com.github.xiaoyminknife4j-spring-ui${lastVersion}
在Spring Boot单体架构下,knife4j提供了starter供开发者快速使用
com.github.xiaoyminknife4j-spring-boot-starter${knife4j.version}
该包会引用所有的knife4j提供的资源&＃xff0c;包括前端Ui的jar包
在Spring Cloud的微服务架构下,每个微服务其实并不需要引入前端的Ui资源,因此在每个微服务的Spring Boot项目下,引入knife4j提供的微服务starter
com.github.xiaoyminknife4j-micro-spring-boot-starter${knife4j.version}
在网关聚合文档服务下,可以再把前端的ui资源引入
com.github.xiaoyminknife4j-spring-boot-starter${knife4j.version}
六、总结
针对knife4j的总结&＃xff0c;无非就是牛逼来形容&＃xff0c;切实的解决了swagger ui不够友好的问题&＃xff0c;而且还可以集成到其他语言的api项目中&＃xff0c;真真切切的需要感谢开发作者提供了这么好的工具供我们使用&＃xff0c;小伙伴是不是心动了&＃xff0c;赶紧去试试吧&＃xff01;enjoy it&＃xff01;
京公网安备 11010802041100号