终于放弃了单调的swagger-ui了,选择了这款神器—knife4j
点击上方蓝色字体,选择“标星公众号”
优质文章,第一时间送达
上一篇:这300G的Java资料是我师傅当年给我的,免费分享给大家(已修复)
下一篇:昨天分享资料不小心把百度网盘深处的秘密泄露了(已修复)
作者最美分享Coder
来源:http://suo.im/5zfEzX
一、介绍
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案(在非Java项目中也提供了前端UI的增强解决方案),前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!
二、开源仓库
Github
https://github.com/xiaoymin/swagger-bootstrap-ui
码云
https://gitee.com/xiaoym/knife4j
三、功能特性
简洁
基于左右菜单式的布局方式,是更符合国人的操作习惯吧.文档更清晰...
个性化配置
个性化配置项,支持接口地址、接口description属性、UI增强等个性化配置功能...
增强
接口排序、Swagger资源保护、导出Markdown、参数缓存众多强大功能...
四、功能预览
在线预览
http://knife4j.xiaominfo.com/doc.html
选择不同接口
Authorize
swagger实体
包含了swagger实体的相关信息
swagger全局设置
全局参数设置
离线文档导出
Knife4j提供导出4种格式的离线文档(Html\Markdown\Word\Pdf)
个性化设置
api文档
搜索功能
五、使用简介
项目结构
目前主要的模块
目前主要的模块包括:模块名称说明: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的前端皮肤,这种情况是最简单的,你项目结构下无需变更
可以直接引用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 ui不够友好的问题,而且还可以集成到其他语言的api项目中,真真切切的需要感谢开发作者提供了这么好的工具供我们使用,小伙伴是不是心动了,赶紧去试试吧!enjoy it!
说句题外话,springboot全家桶技术交流群可以加我微信,但是坑位有限哦,由于忙于工作,有时不能及时回复大家,请多包涵。
精彩推荐
1、SpringBoot 单元测试利器——Mockito2、MyBatis 事务管理解析:颠覆你心中对事务的理解!3、Git 高级用法小抄4、一看就会,编写自己的SpringBoot-Starter5、JVM 性能调优监控工具 jps、jstack、jmap、jhat、jstat、hprof 使用详解6、未来有望干掉 Python 和 JavaScript 的编程语言7、冒着被开除风险也要给大家看看看这份Spring Cloud 总结8、全面了解 Nginx 主要应用场景
点个在看少个 bug
终于放弃了单调的swagger-ui了,选择了这款神器—knife4j相关推荐
- 终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章 来源:最美分享Coder toutiao.com/i6789135 ...
- ASP.NET Core 在 Swagger UI 中显示自定义的 Header Token
Swagger 是个好东西,对于前后端分离的网站来说,不仅是提高前后端开发人员沟通效率的利器,也大大方便了后端人员测试 API.有时候,API 中可能需要在 Header 中设置认证参数,比如 aut ...
- Flask 系列之 构建 Swagger UI 风格的 WebAPI
说明 操作系统:Windows 10 Python 版本:3.7x 虚拟环境管理器:virtualenv 代码编辑器:VS Code 实验 环境初始化 # 创建项目目录 mkdir helloworl ...
- Swagger UI
Swagger UI allows anyone - be it your development team or your end consumers - to visualize and inte ...
- Swagger UI 与SpringMVC的整合 II
pom.xml <!-- swagger开始 --><dependency><groupId>io.springfox</groupId><art ...
- SpringMVC+JWT+Swagger UI+RestFul
前言: 其实很早就想写这篇文章了,因为我觉得这会对很多新手有指引作用,当初自己也是瞎子过河的摸索着过来的.目前后台开发比较流行的MVC框架中使用Spring MVC还是比较多的,当然还有Spring ...
- [第二篇]如何在ASP.Net Core的生产环境中使用OAuth保护swagger ui
在我上篇文章如何在ASP.Net Core的生产环境中保护swagger ui中,我们讨论了如何使用基本身份验证来保护 swagger ui. 使用 OAuth 2.0 和 OpenIdConnect ...
- openapi_MicroProfile OpenAPI上的Swagger UI
openapi MicroProfile OpenApi为我们提供了一种使用OpenApi 3描述我们JAX-RS API的标准化方法.如果您以前使用过swagger-jaxrs和swagger- 批 ...
- MicroProfile OpenAPI上的Swagger UI
MicroProfile OpenApi为我们提供了一种使用OpenApi 3描述我们JAX-RS API的标准化方法.如果您以前使用过swagger-jaxrs和swagger-annotation ...
最新文章
- 关于“插入图片”等功能无法使用的问题
- 【数据挖掘笔记二】认识数据
- 【图像处理】——Python实现图像加噪(随机噪声、椒盐噪声、高斯噪声等)
- element table 组件内容换行方案
- ios时间相差多少天_上海自驾拉萨,走川进青出,应如何规划线路?需要多少天时间?...
- RESTful 架构
- APP推广有效果,APP地推要以用户需求为核心
- jQuery 配置和基本语法
- Rosie's Frankly Speaking
- Silverlight语音朗读
- 【开源项目12】Retrofit – Java(Android) 的REST 接口封装类库
- linux基本命令学习(一)文件处理命令
- 35. 第一个只出现一次的字符(C++版本)
- 论文阅读-可变形卷积v2: More Deformable, Better Results
- micropython常用模块-Python时间模块之datetime
- bufferedwriter怎么写入tab_电脑越用越卡是怎么回事?教你三招恢复火箭般的速度...
- JAVA获取硬盘序列号
- 文献html阅读器,强烈推荐文献阅读器CAJviewer——大学生阅读文献、论文必备工具!!!...
- java编写时间流逝_如何测量Java中的时间流逝?
- 计算机领域国际顶级会议