Swagger友好UI工具之Knife4j

315 阅读2分钟

先上效果图:

image.png

Knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!

Knife4j的前身是swagger-bootstrap-ui,为了契合微服务的架构发展,由于原来swagger-bootstrap-ui采用的是后端Java代码+前端Ui混合打包的方式,在微服务架构下显的很臃肿,因此项目正式更名为knife4j

项目模块 目前主要的模块包括:

模块名称

说明 knife4j 为Java MVC框架集成Swagger的增强解决方案 knife4j-admin 云端Swagger接口文档注册管理中心,集成gateway网关对任意微服务文档进行组合集成 knife4j-extension chrome浏览器的增强swagger接口文档ui,快速渲染swagger资源 knife4j-service 为swagger服务的一系列接口服务程序 knife4j-front knife4j-spring-ui的纯前端静态版本,用于集成非Java语言使用 swagger-bootstrap-ui knife4j的前身,最后发布版本是1.9.6 官方文档:doc.xiaominfo.com/knife4j/doc…

备份文档地址:xiaoym.gitee.io/knife4j/

效果(2.0版):knife4j.xiaominfo.com/doc.html

效果(旧版本):swagger-bootstrap-ui.xiaominfo.com/doc.html

示例:gitee.com/xiaoym/swag…

交流: doc.xiaominfo.com/knife4j/doc…

源码分析:www.xiaominfo.com/2019/05/20/…

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

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

新版本引用

com.github.xiaoymin knife4j-spring-ui ${lastVersion} Spring Boot项目单体架构使用增强功能 在Spring Boot单体架构下,knife4j提供了starter供开发者快速使用 com.github.xiaoymin knife4j-spring-boot-starter ${knife4j.version} 该包会引用所有的knife4j提供的资源,包括前端Ui的jar包

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

com.github.xiaoymin knife4j-micro-spring-boot-starter ${knife4j.version} 对外提供的地址依然是doc.html

访问:http://ip:port/doc.html

项目Demo示例

Demo示例见另外项目地址:gitee.com/xiaoym/swag…