终于放弃了单调的swagger-ui了，选择了这款神器—knife4j

沙海
沙海
沙海
3180
文章
2
评论
2021年6月22日05:05:24Java评论46字数 2737阅读9分7秒阅读模式
摘要

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j 点击关注 ? Java基基

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j

点击关注 ? Java基基 文章源自JAVA秀-https://www.javaxiu.com/34534.html

收录于话题文章源自JAVA秀-https://www.javaxiu.com/34534.html

#Java基基文章源自JAVA秀-https://www.javaxiu.com/34534.html

174个文章源自JAVA秀-https://www.javaxiu.com/34534.html

    点击上方“Java基基”，选择“设为星标”文章源自JAVA秀-https://www.javaxiu.com/34534.html

做积极的人，而不是积极废人！文章源自JAVA秀-https://www.javaxiu.com/34534.html

文章源自JAVA秀-https://www.javaxiu.com/34534.html

源码精品专栏文章源自JAVA秀-https://www.javaxiu.com/34534.html

 文章源自JAVA秀-https://www.javaxiu.com/34534.html

文章源自JAVA秀-https://www.javaxiu.com/34534.html

来源：suo.im/5zfEzX文章源自JAVA秀-https://www.javaxiu.com/34534.html

一、介绍

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案（在非Java项目中也提供了前端UI的增强解决方案），前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!文章源自JAVA秀-https://www.javaxiu.com/34534.html

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

图片文章源自JAVA秀-https://www.javaxiu.com/34534.html

二、开源仓库

Github

https://github.com/xiaoymin/swagger-bootstrap-ui

码云

https://gitee.com/xiaoym/knife4j

三、功能特性

简洁

基于左右菜单式的布局方式,是更符合国人的操作习惯吧.文档更清晰...文章源自JAVA秀-https://www.javaxiu.com/34534.html

个性化配置

个性化配置项,支持接口地址、接口description属性、UI增强等个性化配置功能...文章源自JAVA秀-https://www.javaxiu.com/34534.html

增强

接口排序、Swagger资源保护、导出Markdown、参数缓存众多强大功能...文章源自JAVA秀-https://www.javaxiu.com/34534.html

四、功能预览

在线预览

http://knife4j.xiaominfo.com/doc.html

选择不同接口

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

图片文章源自JAVA秀-https://www.javaxiu.com/34534.html

Authorize

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

图片文章源自JAVA秀-https://www.javaxiu.com/34534.html

swagger实体

包含了swagger实体的相关信息文章源自JAVA秀-https://www.javaxiu.com/34534.html

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

图片文章源自JAVA秀-https://www.javaxiu.com/34534.html

swagger全局设置

全局参数设置文章源自JAVA秀-https://www.javaxiu.com/34534.html

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

图片文章源自JAVA秀-https://www.javaxiu.com/34534.html

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

图片文章源自JAVA秀-https://www.javaxiu.com/34534.html

离线文档导出

Knife4j提供导出4种格式的离线文档(Html\Markdown\Word\Pdf)文章源自JAVA秀-https://www.javaxiu.com/34534.html

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

图片文章源自JAVA秀-https://www.javaxiu.com/34534.html

个性化设置

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

图片文章源自JAVA秀-https://www.javaxiu.com/34534.html

api文档

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

图片文章源自JAVA秀-https://www.javaxiu.com/34534.html

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

图片文章源自JAVA秀-https://www.javaxiu.com/34534.html

搜索功能

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

图片文章源自JAVA秀-https://www.javaxiu.com/34534.html

五、使用简介

项目结构

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

图片文章源自JAVA秀-https://www.javaxiu.com/34534.html

目前主要的模块

目前主要的模块包括：模块名称说明：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的前端皮肤，这种情况是最简单的,你项目结构下无需变更文章源自JAVA秀-https://www.javaxiu.com/34534.html

可以直接引用swagger-bootstrap-ui的最后一个版本1.9.6或者使用knife4j-spring-ui文章源自JAVA秀-https://www.javaxiu.com/34534.html

老版本引用文章源自JAVA秀-https://www.javaxiu.com/34534.html

<dependency>  <groupId>com.github.xiaoymin</groupId>  <artifactId>swagger-bootstrap-ui</artifactId>  <version>1.9.6</version></dependency>

新版本引用文章源自JAVA秀-https://www.javaxiu.com/34534.html

<dependency>  <groupId>com.github.xiaoymin</groupId>  <artifactId>knife4j-spring-ui</artifactId>  <version>${lastVersion}</version></dependency>

Spring Boot项目单体架构使用增强功能

在Spring Boot单体架构下,knife4j提供了starter供开发者快速使用文章源自JAVA秀-https://www.javaxiu.com/34534.html

<dependency>  <groupId>com.github.xiaoymin</groupId>  <artifactId>knife4j-spring-boot-starter</artifactId>  <version>${knife4j.version}</version></dependency>

该包会引用所有的knife4j提供的资源，包括前端Ui的jar包文章源自JAVA秀-https://www.javaxiu.com/34534.html

Spring Cloud微服务架构

在Spring Cloud的微服务架构下,每个微服务其实并不需要引入前端的Ui资源,因此在每个微服务的Spring Boot项目下,引入knife4j提供的微服务starter文章源自JAVA秀-https://www.javaxiu.com/34534.html

<dependency>  <groupId>com.github.xiaoymin</groupId>  <artifactId>knife4j-micro-spring-boot-starter</artifactId>  <version>${knife4j.version}</version></dependency>

在网关聚合文档服务下,可以再把前端的ui资源引入文章源自JAVA秀-https://www.javaxiu.com/34534.html

<dependency>   <groupId>com.github.xiaoymin</groupId>   <artifactId>knife4j-spring-boot-starter</artifactId>   <version>${knife4j.version}</version></dependency>

六、总结

针对knife4j的总结，无非就是牛逼来形容，切实的解决了swagger ui不够友好的问题，而且还可以集成到其他语言的api项目中，真真切切的需要感谢开发作者提供了这么好的工具供我们使用，小伙伴是不是心动了，赶紧去试试吧！enjoy it！文章源自JAVA秀-https://www.javaxiu.com/34534.html

- END -文章源自JAVA秀-https://www.javaxiu.com/34534.html

欢迎加入我的知识星球，一起探讨架构，交流源码。加入方式，长按下方二维码噢：文章源自JAVA秀-https://www.javaxiu.com/34534.html

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

已在知识星球更新源码解析如下：文章源自JAVA秀-https://www.javaxiu.com/34534.html

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

终于放弃了单调的swagger-ui了，选择了这款神器—knife4j文章源自JAVA秀-https://www.javaxiu.com/34534.html

最近更新《芋道 SpringBoot 2.X 入门》系列，已经 20 余篇，覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。文章源自JAVA秀-https://www.javaxiu.com/34534.html

提供近 3W 行代码的 SpringBoot 示例，以及超 4W 行代码的电商微服务项目。文章源自JAVA秀-https://www.javaxiu.com/34534.html

获取方式：点“在看”，关注公众号并回复 666 领取，更多内容陆续奉上。文章源自JAVA秀-https://www.javaxiu.com/34534.html

文章源自JAVA秀-https://www.javaxiu.com/34534.html

文章有帮助的话，在看，转发吧。谢谢支持哟 (*^__^*）
文章源自JAVA秀-https://www.javaxiu.com/34534.html

阅读原文文章源自JAVA秀-https://www.javaxiu.com/34534.html

继续阅读
历史上的今天
6月
22
速蛙云 - 极致体验，强烈推荐！！！购买套餐就免费送各大视频网站会员！快速稳定、独家福利社、流媒体稳定解锁！速度快，全球上网、视频、游戏加速、独立IP均支持！基础套餐性价比很高！这里不多说，我一直正在使用，推荐购买：https://www.javaxiu.com/59919.html
weinxin
资源分享QQ群
本站是JAVA秀团队的技术分享社区, 会经常分享资源和教程; 分享的时代, 请别再沉默！
沙海
匿名

发表评论

匿名网友 填写信息

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定