终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j

点击上方“芋道源码”,选择“设为星标”

做积极的人,而不是积极废人!

源码精品专栏

 
  • 原创 | Java 2019 超神之路,很肝~

  • 中文详细注释的开源项目

  • RPC 框架 Dubbo 源码解析

  • 网络应用框架 Netty 源码解析

  • 消息中间件 RocketMQ 源码解析

  • 数据库中间件 Sharding-JDBC 和 MyCAT 源码解析

  • 作业调度中间件 Elastic-Job 源码解析

  • 分布式事务中间件 TCC-Transaction 源码解析

  • Eureka 和 Hystrix 源码解析

  • Java 并发源码

来源:最美分享Coder

toutiao.com/i6789135368064074253

  • 一、介绍

  • 二、开源仓库

  • 三、功能特性

  • 四、功能预览

  • 五、使用简介

  • 六、总结


一、介绍

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案(在非Java项目中也提供了前端UI的增强解决方案),前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!

终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j_第1张图片

二、开源仓库

  • Github

https://github.com/xiaoymin/swagger-bootstrap-ui
  • 码云

https://gitee.com/xiaoym/knife4j

三、功能特性

  • 简洁

基于左右菜单式的布局方式,是更符合国人的操作习惯吧.文档更清晰...

  • 个性化配置

个性化配置项,支持接口地址、接口description属性、UI增强等个性化配置功能...

  • 增强

接口排序、Swagger资源保护、导出Markdown、参数缓存众多强大功能...

四、功能预览

  • 在线预览

http://knife4j.xiaominfo.com/doc.html
  • 选择不同接口

终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j_第2张图片

  • Authorize

终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j_第3张图片

  • swagger实体

包含了swagger实体的相关信息

终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j_第4张图片

  • swagger全局设置

全局参数设置

终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j_第5张图片

终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j_第6张图片

  • 离线文档导出

Knife4j提供导出4种格式的离线文档(Html\Markdown\Word\Pdf)

终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j_第7张图片

  • 个性化设置

终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j_第8张图片

  • api文档

终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j_第9张图片

终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j_第10张图片

  • 搜索功能

终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j_第11张图片

五、使用简介

  • 项目结构

终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j_第12张图片

  • 目前主要的模块

目前主要的模块包括:模块名称说明: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

老版本引用


  com.github.xiaoymin
  swagger-bootstrap-ui
  1.9.6

新版本引用


  com.github.xiaoymin
  knife4j-spring-ui
  ${lastVersion}

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

在Spring Boot单体架构下,knife4j提供了starter供开发者快速使用


  com.github.xiaoymin
  knife4j-spring-boot-starter
  ${knife4j.version}

该包会引用所有的knife4j提供的资源,包括前端Ui的jar包

  • Spring Cloud微服务架构

在Spring Cloud的微服务架构下,每个微服务其实并不需要引入前端的Ui资源,因此在每个微服务的Spring Boot项目下,引入knife4j提供的微服务starter


  com.github.xiaoymin
  knife4j-micro-spring-boot-starter
  ${knife4j.version}

在网关聚合文档服务下,可以再把前端的ui资源引入


   com.github.xiaoymin
   knife4j-spring-boot-starter
   ${knife4j.version}

六、总结

针对knife4j的总结,无非就是牛逼来形容,切实的解决了swagger ui不够友好的问题,而且还可以集成到其他语言的api项目中,真真切切的需要感谢开发作者提供了这么好的工具供我们使用,小伙伴是不是心动了,赶紧去试试吧!enjoy it!



欢迎加入我的知识星球,一起探讨架构,交流源码。加入方式,长按下方二维码噢

已在知识星球更新源码解析如下:


最近更新《芋道 SpringBoot 2.X 入门》系列,已经 20 余篇,覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。

提供近 3W 行代码的 SpringBoot 示例,以及超 4W 行代码的电商微服务项目。

获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。

如果你喜欢这篇文章,喜欢,转发。

生活很美好,明天见(。・ω・。)ノ♡

你可能感兴趣的:(终于放弃了单调的 Swagger 了,选择了这款神器 Knife4j)