knife4j 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
knife4j 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
knife4j 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 Apache
开发语言 Java JavaScript
操作系统 跨平台
软件类型 开源软件
所属分类 程序开发UI组件库
开源组织
地区 国产
投 递 者 八一菜刀
适用人群 未知
收录时间 2017-04-19

软件简介

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

GitHub    Gitee    项目文档    项目demo    在线体验

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

更名后主要专注的方面

  • 前后端Java代码以及前端Ui模块进行分离,在微服务架构下使用更加灵活
  • 提供专注于Swagger的增强解决方案,不同于只是改善增强前端Ui部分

效果:http://swagger-bootstrap-ui.xiaominfo.com/doc.html

示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo

 

文档:https://doc.xiaominfo.com/

源码分析:https://www.xiaominfo.com/2019/05/20/springfox-0/

项目模块

目前主要的模块包括:

模块名称 说明
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

业务场景

不使用增强功能,纯粹换一个swagger的前端皮肤

不使用增强功能,纯粹换一个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-bootstrap-ui

对外提供的地址依然是doc.html

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

即可查看文档

这是永远不会改变的

提ISSUES必看

虽然建立了QQ交流群,但是很多没用加群的朋友会通过ISSUES来反馈问题,提ISSUES本身是一个很好的技术习惯,这有助于帮助我能很好的定位问题所在,但因为我并不是实时关注,所以经常在我处理issues的时候,看到很多朋友提的问题却也无从着手,写下一些建议,希望提ISSUES的朋友能在提的时候都有涉及到:

1、swagger-bootstrap-ui和springfox-swagger的版本号,这个尤为重要,很多低版本出现的问题有可能我在新发布的版本中已经解决了,每个版本都有更新日志,可以参考这篇文档:https://doc.xiaominfo.com/changelog/

2、提ISSUES时贴图、贴代码,代码不用贴逻辑,只需要贴接口层即可,还有相关的实体类(如果有涉及的话),这些信息有助于我快速定位问题,省去了来回沟通的成本,提高大家的效率

3、在QQ交流群沟通的朋友我也希望能通过提ISSUE来记录下我们沟通的过程,我并非实时处理此问题,这让我集中再处理issues的时候有助于拉回我们彼此沟通时的场景,最终在新版本解决问题

4、swagger-bootstrap-ui使用的是传统的JS技术,jQuery+Dom操作,打包后的源码也并没有压缩处理,代码注释部分我也有说明,应该是能理解的,如果我没有及时处理碰到的问题,欢迎大家提交pr,毕竟众人拾柴火焰高嘛

项目Demo示例

Demo示例见另外项目地址:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo

模块 说明
knife4j-spring-boot-demo 在Spring Boot架构下集成knife4j的项目示例
knife4j-spring-boot-single-demo 在Spring Boot单体架构下集成knife4j的项目示例
knife4j-spring-cloud-gateway 在Spring Cloud微服务架构下通过gateway网集成knife4j的示例
swagger-bootstrap-ui-demo-mvc 在Spring MVC模式下集成swagger-bootstrap-ui
swagger-bootstrap-ui-demo 在Spring Boot单体架构下集成swagger-bootstrap-ui
swagger-bootstrap-ui-gateway 在Spring Cloud微服务架构下通过gateway网关集成swagger-bootstrap-ui
swagger-bootstrap-ui-zuul 在Spring Cloud微服务架构下通过zuul网关集成swagger-bootstrap-ui

界面效果

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论

点击加入讨论🔥(28)
发表了资讯
2021/06/28 18:39

Knife4j 2.0.9 发布,解决 issue 150+

Knife4j前身是swagger-bootstrap-ui,是一个为Swagger接口文档赋能的工具 文档:https://xiaoym.gitee.io/knife4j/ 效果(旧版):http://swagger-bootstrap-ui.xiaominfo.com/doc.html 效果(2.X版):http://knife4j.xiaominfo.com/doc.html Gitee:https://gitee.com/xiaoym/knife4j GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui 示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo 日志 OpenAPI3 1、在Ope...

9
10
2020/12/27 20:49

Knife4jAggregationDesktop 独立渲染 OpenAPI 规范文档-v1.0版本发布

Knife4jAggregationDesktop是一款基于聚合组件Knife4jAggregation特性的独立部署的聚合OpenAPI文档软件,脱离Spring、Spring Boot技术架构体系,开发者下载后独立部署启动。 主要功能作用: 独立部署(依赖Java JDK8环境) 专注聚合OpenAPI文档,在线预览和调试均可,拥有Knife4j的全部特性 继承Knife4jAggregation的全部特性,支持Disk、Cloud、Eureka、Nacos四种模式的OpenAPI文档聚合显示 基于动态文件配置方式,无需重启服务,...

2
11
2020/11/23 09:44

Knife4j 2.0.8 发布,轻量级微服务聚合文档中间件诞生

Knife4j前身是swagger-bootstrap-ui,是一个为Swagger接口文档赋能的工具 文档:https://xiaoym.gitee.io/knife4j/ 效果(旧版):http://swagger-bootstrap-ui.xiaominfo.com/doc.html 效果(2.X版):http://knife4j.xiaominfo.com/doc.html Gitee:https://gitee.com/xiaoym/knife4j GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui 示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo 特性 & 优化 1、构建响应...

5
5
2020/11/02 10:26

Knife4j 2.0.7 发布,细节优化

Knife4j前身是swagger-bootstrap-ui,是一个为Swagger接口文档赋能的工具 文档:https://doc.xiaominfo.com 效果(旧版):http://swagger-bootstrap-ui.xiaominfo.com/doc.html 效果(2.X版):http://knife4j.xiaominfo.com/doc.html Gitee:https://gitee.com/xiaoym/knife4j GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui 示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo 特性 & 优化 1、服务端创建Doc...

2
7
发表了资讯
2020/10/26 12:48

Knife4j 2.0.6 发布,支持 OpenAPI3 及 Auth2 认证

Knife4j前身是swagger-bootstrap-ui,是一个为Swagger接口文档赋能的工具 关键词:OpenAPI3、Auth2.0、AfterScript、Springfox3.0、增强改善 文档:https://doc.xiaominfo.com 效果(旧版):http://swagger-bootstrap-ui.xiaominfo.com/doc.html 效果(2.X版):http://knife4j.xiaominfo.com/doc.html Gitee:https://gitee.com/xiaoym/knife4j GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui 示例:https://gitee.com...

6
10
2020/09/15 09:29

Knife4j 2.0.5 版本发布,性能优化

Knife4j前身是swagger-bootstrap-ui,是一个为Swagger接口文档赋能的工具 文档:https://doc.xiaominfo.com 效果(旧版):http://swagger-bootstrap-ui.xiaominfo.com/doc.html 效果(2.X版):http://knife4j.xiaominfo.com/doc.html Gitee:https://gitee.com/xiaoym/knife4j GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui 示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo 特性 & 优化 1、Ui整体性能优化...

18
22
发表于服务端专区
2020/06/28 10:15

Knife4j 2.0.4 版本发布,支持自定义 Host

Knife4j前身是swagger-bootstrap-ui,是一个为Swagger接口文档赋能的工具 文档:https://doc.xiaominfo.com 效果(旧版):http://swagger-bootstrap-ui.xiaominfo.com/doc.html 效果(2.X版):http://knife4j.xiaominfo.com/doc.html Gitee:https://gitee.com/xiaoym/knife4j GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui 示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo 特性 & 优化 1、支持UiConfigu...

13
19
发表于大前端专区
2020/05/25 09:36

Knife4j 2.0.3 正式发布,支持 springdoc 和 i18n

Knife4j前身是swagger-bootstrap-ui,是一个为Swagger接口文档赋能的工具 文档:https://doc.xiaominfo.com 效果(旧版):http://swagger-bootstrap-ui.xiaominfo.com/doc.html 效果(2.X版):http://knife4j.xiaominfo.com/doc.html Gitee:https://gitee.com/xiaoym/knife4j GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui 示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo 特性 & 优化 knife4j 1、读取M...

9
31
发表于大前端专区
2020/05/20 11:22

knife4j-admin v1.0发布,任意聚合 Swagger 文档

knife4j-admin是一个基于Spring Cloud Gateway网关,通过网关的特性,结合knife4j对Swagger的文档进行动态聚合的管理平台 平台特点: 跨语言、跨平台 任意聚合Swagger文档,动态发布,调试 文档个性化配置、权限等 彻底告别聚合网关文档等由于软件版本等造成的技术集成问题 独立部署 目前V1.0版本提供的功能: 项目管理:查看项目列表,新增项目文档 文档预览:通过项目的JSON结构,解析动态添加至Spring Cloud Gateway网关进行文档聚合...

4
28
发表于大前端专区
2020/03/09 08:50

Knife4j 2.0.2 正式发布,Swagger 接口文档赋能工具

Knife4j前身是swagger-bootstrap-ui,是一个为Swagger接口文档赋能的工具 文档:https://doc.xiaominfo.com 效果(旧版):http://swagger-bootstrap-ui.xiaominfo.com/doc.html 效果(2.X版):http://knife4j.xiaominfo.com/doc.html Gitee:https://gitee.com/xiaoym/knife4j GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui 示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo 特性 & 优化 knife4j 1、新增k...

4
29
发表于大前端专区
2019/12/23 09:15

Knife4j 2.0.1 发布,细节处理!

Knife4j前身是swagger-bootstrap-ui,是一个为Swagger接口文档服务的工具 文档:http://doc.xiaominfo.com 效果(旧版):http://swagger-bootstrap-ui.xiaominfo.com/doc.html 效果(2.0版):http://knife4j.xiaominfo.com/doc.html Gitee:https://gitee.com/xiaoym/knife4j GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui 示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo 特性 & 优化 knife4j-spring-ui ...

10
26
发表于大前端专区
2019/12/16 08:55

Knife4j 2.0 发布,涅槃重生~!

Knife4j前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍,更名也是希望把她做成一个为Swagger接口文档服务的通用性解决方案,不仅仅只是专注于前端Ui前端.虽然目前还只是在前端,但以后功能肯定不止于此. 2.0版本主要是使用Vue+Ant Design Vue对前端Ui进行重写,该版本是真正的前后端分离版本,同时依赖于Vue的技术生态,以后会有更多有趣的功能实现,全方位满足开发者的需要. 文档:http://...

14
37
发表于大前端专区
2019/08/29 09:29

swagger-bootstrap-ui 1.9.6 发布,解决长整型精度丢失的问题

swagger-bootstrap-ui 1.9.6 发布了。swagger-bootstrap-ui是 Swagger 的增强UI 实现,使文档更友好一点儿 文档:http://doc.xiaominfo.com 效果:http://swagger-bootstrap-ui.xiaominfo.com/doc.html Gitee:https://gitee.com/xiaoym/swagger-bootstrap-ui GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui 示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo 重要说明 这是swagger-bootstrap-ui的最后一个版...

12
34
发表于大前端专区
2019/07/31 21:06

swagger-bootstrap-ui 1.9.5 发布,支持过滤请求参数

swagger-bootstrap-ui 1.9.5 发布了。swagger-bootstrap-ui是 Swagger 的增强UI 实现,使文档更友好一点儿 文档:http://doc.xiaominfo.com 效果:http://swagger-bootstrap-ui.xiaominfo.com/doc.html Gitee:https://gitee.com/xiaoym/swagger-bootstrap-ui GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui 示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo 特性&优化 1、针对文件上传响应JSON内容时,内容不...

10
17
发表于大前端专区
2019/06/10 17:17

swagger-bootstrap-ui 1.9.4 发布,扩展支持动态字段注释

swagger-bootstrap-ui 1.9.4 发布了。swagger-bootstrap-ui是 Swagger 的增强UI 实现,使文档更友好一点儿 文档:http://doc.xiaominfo.com 效果:http://swagger-bootstrap-ui.xiaominfo.com/doc.html Gitee:https://gitee.com/xiaoym/swagger-bootstrap-ui GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui 示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo 特性&优化 1、最低需要JDK 1.8支持 2、单独接口通...

12
42
发表于大前端专区
2019/05/20 09:20

swagger-bootstrap-ui 应用扩展程序 1.0.0 发布

随着swagger-bootstrap-ui已经历时两年多,发布了26个版本,目前也得到的很多Java开发者的青睐,如果你是使用Swagger来构建你的文档服务,那么,swagger-bootstrap-ui你一定不容错过 正因为如此,在Java领域已经非常方便的集成到项目中了,但因为Swagger本身是规范框架,所以只要是支持Swagger的语言,都应该能使用swagger-bootstrap-ui这款渲染ui程序,但是由于时间原因,我一直没有将静态文件,核心渲染JS剥离出来,虽然前段时间剥离了一版...

1
38
发表于大前端专区
2019/04/23 16:44

swagger-bootstrap-ui 1.9.3 发布,i18n及自定义文档支持

swagger-bootstrap-ui 1.9.3 发布了。swagger-bootstrap-ui是 Swagger 的增强UI 实现,使文档更友好一点儿 文档:http://doc.xiaominfo.com 效果:http://swagger-bootstrap-ui.xiaominfo.com/doc.html Gitee:https://gitee.com/xiaoym/swagger-bootstrap-ui GitHub:https://github.com/xiaoymin/Swagger-Bootstrap-UI 示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo 特性&优化 1、增加i18n国际化支持(中文、English...

9
80
发表于大前端专区
2019/04/08 08:49

swagger-bootstrap-ui 1.9.2 发布,提供前后端分离解决方案

swagger-bootstrap-ui 1.9.2 发布了。swagger-bootstrap-ui是 Swagger 的增强UI 实现,使文档更友好一点儿 GitHub Gitee 文档 示例代码 在线体验 主要更新如下: 特性&优化 1、增加地址栏参数访问,快速个性化设置功能,可参考文档 2、修改SecurityConfiguration中关于Environment的注入方式,改为属性注解注入,提供默认无参构造,避免某些情况下使用SpringAop导致异常issue #ITI1C @Gitee 3、针对存在format属性字段类型,显示for...

12
61
发表于大前端专区
2019/03/11 09:22

swagger-bootstrap-ui 1.9.1 发布,优化大数据响应接口

swagger-bootstrap-ui 1.9.1 发布了。swagger-bootstrap-ui是 Swagger 的增强UI 实现,使文档更友好一点儿 GitHub Gitee 文档 示例代码 在线体验 主要更新如下: 特性&优化 1、优化大数据响应接口,UI渲染卡顿,导致浏览器崩溃 2、ApiInfo.description支持htmlissue #65 @GitHub 3、合并pr#61,优化array子类型为基础类型时schema显示为空的情况 4、响应数据编辑器增加换行模式,针对响应某个字段特别长时,自动换行. Bug修复 1、关...

11
65
发表于大前端专区
2019/02/25 08:38

SwaggerBootstrapUi 1.9.0 发布,提供Swagger资源保护

SwaggerBootstrapUi 1.9.0 发布,提供Swagger资源保护 SwaggerBootstrapUi 1.9.0 发布了。SwaggerBootstrapUi是 Swagger 的增强UI 实现,使文档更友好一点儿 GitHub Gitee 文档 示例代码 在线体验 主要更新如下: 特性&优化 1、优化未给与tags分组时,Ui默认赋值default. 2、针对使用SwaggerBootstrapUi的增强排序功能时导致升级Springfox-Swagger必须升级到2.9.2引起的jar包冲突版本问题,Ui做向下兼容处理,Springfox-Swagger版...

8
43
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表了博客
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
发表了问答
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
暂无内容
28 评论
503 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部