08 Knife4j 2.0.2发布,Swagger接口文档赋能工具]

Knife4j前身是swagger-bootstrap-ui,是一个为Swagger接口文档赋能的工具

文档：https://doc.xiaominfo.com (opens new window)

效果(旧版):http://swagger-bootstrap-ui.xiaominfo.com/doc.html

效果(2.X版)：http://knife4j.xiaominfo.com/doc.html (opens new window)

Gitee：https://gitee.com/xiaoym/knife4j

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

示例：https://gitee.com/xiaoym/swagger-bootstrap-ui-demo

# 特性 & 优化

# knife4j

1、新增knife4j-dependencies模块,管理knife4j的相关Maven引用,可以以Maven的BOM方式引入Knife4j

2、官网 (opens new window)文档同步更新.

3、解决swagger-annotations导致的版本冲突gitee #I17G31 (opens new window)、GitHub #191 (opens new window)

# knife4j-spring-ui

1、修复切换tab之后再次发送请求不带参数且不显示响应数据的问题，调试异常等问题PR 13 @gitee (opens new window)、gitee #I17FFX (opens new window)、GitHub #196 (opens new window)、GitHub #187 (opens new window)

2、优化调试框全部选中的问题,在取消全选时,只有在输入参数改变时才会选中该参数,取消原来默认选中全部参数gitee #I19V6D (opens new window)

3、针对Form表单类型的请求构造curl命令行时在未输入值的情况下为null的情况,修改为空字符串gitee #I18IBZ (opens new window)

4、优化全局参数设置功能,针对参数数据太长不换行问题，以及参数需要修改时需要重新删除的交互体验，开发者在新增参数后可以方便的更改参数数据值以及参数的类型gitee #I17OV1 (opens new window)、gitee #I19GJK (opens new window)、gitee #I1A9V1 (opens new window)、gitee #I18HMJ (opens new window)、GitHub #176 (opens new window)

5、请求参数在未给定example默认值的情况下,文本输入框的placeHolder属性显示该字段的文字说明gitee #I17RKI (opens new window)

6、修复增强属性忽略参数不生效的问题gitee #PR-16 (opens new window)、gitee #I136KU (opens new window)、gitee #I187VN (opens new window)、gitee #I16A71 (opens new window)

7、调试参数框增加对后端枚举的支持,改输入框为下拉选择框gitee #I18MHO (opens new window)

8、service-worker.js报404问题，构建打包时添加此文件gitee #I17D0Y (opens new window)、GitHub #185 (opens new window)

9、get请求参数出现特殊字符未编码处理导致出现400错误gitee #I19C8Y (opens new window)

10、后端新增接口或者接口编辑后,在ui界面显示更新标志,在菜单上会出现一个蓝色的徽标gitee #I1AQFW (opens new window)，如下图:

11、后端增强注解@ApiOperationSupport(author = "xiaoymin@foxmail.com")支持每个接口提供开发者的呈现,最终如下图：

12、调试发送按钮增加loading效果,针对接口响应较长的情况下提升交互效果

13、针对Authorize菜单栏的参数,保存参数是全局保存,其它逻辑分组的接口再调试时,不需要再保存一次新值gitee #I16Z10 (opens new window)

14、修复部分情况响应字段在ace-editor编辑器右边栏不显示字段说明的情况gitee #I17F5Y (opens new window)

15、搜索框完善对接口请求Api地址栏的模糊搜索匹配gitee #I19EN0 (opens new window)、gitee #I1B0Q9 (opens new window)

16、调试响应数据行太长,无法换行的问题gitee #I17F1J (opens new window)

17、在当前接口无参数的情况下,界面添加全局参数无效果的bug

如果你后端是Java+Spring的技术栈，在使用springfox的同时，想换一个Swagger的Ui皮肤，通过在pom.xml中直接引入即可,如下：

<dependency>
  <groupId>com.github.xiaoymin</groupId>
  <artifactId>knife4j-spring-ui</artifactId>
  <version>2.0.2</version>
</dependency>

# Knife4j-Spring

使用Spring Boot的技术栈可以通过引用starter的方式快速引入使用,注意该starter组件是包含Ui的,如下：

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

如果是微服务的情况下,微服务其实不需要引用Ui的jar包，只需要在网关引用Ui的jar包依赖,所以在微服务情况下,使用增强属性只需要引用微服务版本的starter依赖,如下：

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

# 特点

基于Vue+Ant Design构建的文档，更强大、清晰的接口文档说明能力以及接口调试能力
左右布局,基于Tabs组件的多文档查阅风格
支持在线导出Html、Markdown、Word、PDF等多种格式的离线文档
接口排序,支持分组及接口的排序功能
支持接口全局在线搜索功能
提供Swagger资源保护策略,保护文档安全
接口调试支持无限参数,开发者调试非常灵活，动态增加、删除参数
全局缓存调试信息,页面刷新后依然存在,方便开发者调试
以更人性化的table树组件展示Swagger Models功能
文档以多tab方式可显示多个接口文档
请求参数栏请求类型、是否必填着颜色区分
主页中粗略统计接口不同类型数量
支持自定义全局参数功能，主页包括header及query两种类型
JSR-303 annotations 注解的支持
更多个性化设置功能

# 界面

接口文档显示界面如下：

接口调试界面如下：

Swagger Models功能

支持导出离线Markdown、Html功能，markdown的表格较原先版本通过缩减显示为树形结构,点击预览导出离线Html效果 (opens new window)，效果图如下：

通过第三方Markdown软件导出的PDF效果如下图:

同时提供了导出离线Html功能,Html功能界面风格和在线几乎没有区别,美观、大方、简洁,点击在线预览效果 (opens new window)，

界面效果如下图：

# Star & Issue

感谢各位朋友的支持,前往https://gitee.com/xiaoym/knife4j (opens new window)点个Star吧~~ ：）

← [v1.0-2020/05/20 Knife4j-Admin 1.0发布,任意聚合 Swagger 文档] [v2.0.1-2019/12/23 Knife4j 2.0.1发布,细节处理！] →

有任何问题请使用Knife4j的标签在OSC社区

进行提问