knife4j 正在参加
2021 年度 OSC 中国开源项目评选
,请投票支持!
knife4j 在
2021 年度 OSC 中国开源项目评选
中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选
正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>>
中场回顾
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/
目前主要的模块包括:
不使用增强功能,纯粹换一个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前身是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...
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、构建响应...
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...
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...
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整体性能优化...
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...
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...
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...
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 ...
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的最后一个版...
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内容时,内容不...
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、单独接口通...
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...
你的行为让我都觉得我自己真是幼稚得可以:有没有一种可能,你所谓 C++ 的东西,也是在我们来说的应用层?而你认为底层就是只是更接近机器码经此而已?有没有一种可能,Python,C# 是用来开发搞底层系统的工具链工具的?有没有一种可能,VB只是随便写写,只是30+年前入行的一种还念?有没有一种可能,你不知道Rust是什么语言?有没有一种可能,这些都随便填填?我记得我似乎一开始填的地方是tw,就是期待有一天。。。有没有一种可能:当你们觉得吧 log4j 漏洞提交国外项目就是多世界牛逼的时候,我们的项目确要“技术先进,不宜展示”?好了,小朋友,请你别纠缠了,大人很忙的,有很多正紧事要做,而不是和你BB玩具。
Informed 是用于在 React 应用程序中构建表单的轻量级框架,开箱即用,支持获取和操作值、验证字段、创建自定义输入、多步骤表单、数组字段等。 示例
// Example.jsx