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

栏目: IT技术 · 发布时间: 4年前

内容简介:作者:最美分享Coder来源:toutiao.com/i6789135368064074253

作者:最美分享Coder

来源:toutiao.com/i6789135368064074253

  • 一、介绍

  • 二、开源仓库

  • 三、功能特性

  • 四、功能预览

  • 五、使用简介

  • 六、总结

一、介绍

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

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

二、开源仓库

  • 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

  • Authorize

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

  • swagger实体

包含了swagger实体的相关信息

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

  • swagger全局设置

全局参数设置

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

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

  • 离线文档导出

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

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

  • 个性化设置

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

  • api文档

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

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

  • 搜索功能

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

五、使用简介

  • 项目结构

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

  • 目前主要的模块

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

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


以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持 码农网

查看所有标签

猜你喜欢:

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

用户体验面面观

用户体验面面观

[美] 库涅夫斯基(Mike Kuniavsky) / 汤海 / 清华大学出版社 / 2010-5 / 69.00

这是一本专注于用户研究和用户体验的经典读物,同时也是一本容易上手的实战手册,从实践者的角度,着重讨论和阐述了用户研究的重要性、主要的用户研究方法和工具,同时借助于实例介绍了相关的应用。全书共3部分18章,深度剖析了何为优秀的用户设计,用户体验包括哪些研究方法和工具,如何 得出和分析用户体验调查结果等。一起来看看 《用户体验面面观》 这本书的介绍吧!

JS 压缩/解压工具
JS 压缩/解压工具

在线压缩/解压 JS 代码

XML 在线格式化
XML 在线格式化

在线 XML 格式化压缩工具

RGB CMYK 转换工具
RGB CMYK 转换工具

RGB CMYK 互转工具