This action will force synchronization from 萧明/knife4j, which will overwrite any changes that you have made since you forked the repository, and can not be recovered!!!
Synchronous operation will process in the background and will refresh the page when finishing processing. Please be patient.
大家好,我在GitChat中写了一篇关于《Knife4j 及 Swagger 在企业开发中的实践》 地址:https://gitbook.cn/gitchat/activity/5f86b4cb1772090f20e13b03
欢迎对 SpringFox、Swagger、Knife4j 感兴趣以及想了解的人员一起来chat
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!
knife4j的前身是swagger-bootstrap-ui
,为了契合微服务的架构发展,由于原来swagger-bootstrap-ui
采用的是后端Java代码+前端Ui混合打包的方式,在微服务架构下显的很臃肿,因此项目正式更名为knife4j
更名后主要专注的方面
效果(2.0版):http://knife4j.xiaominfo.com/doc.html
效果(旧版本):http://swagger-bootstrap-ui.xiaominfo.com/doc.html
示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo
交流:
关注公众号"Knife4j",点击菜单“交流群”获取加群二维码
源码分析:https://doc.xiaominfo.com/docs/action/springfox
目前主要的模块包括:
模块名称 | 说明 |
---|---|
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-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单体架构下,knife4j提供了starter供开发者快速使用
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>${knife4j.version}</version>
</dependency>
该包会引用所有的knife4j提供的资源,包括前端Ui的jar包
在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
即可查看文档
这是永远不会改变的
虽然建立了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示例见另外项目地址: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 |
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。