knife4j 发行版 - Gitee.com

v1.9.2

83da3b6

2019-04-08 08:51

swagger-bootstrap-ui 1.9.2 发布，提供前后端分离解决方案

最后提交信息为：文档完善

v1.9.1

8696d0a

2019-03-11 11:27

swagger-bootstrap-ui 1.9.1 发布，优化大数据响应接口

最后提交信息为： 1.9.1 released

v1.9.0

b5ca318

2019-02-25 08:48

SwaggerBootstrapUi 1.9.0 发布，提供Swagger资源保护

最后提交信息为： 1.9.0 released fixed some doc description

v1.8.9

b2e3648

2019-01-11 17:30

swagger-bootstrap-ui 1.8.9 发布，Swagger增强UI 实现

最后提交信息为： 1.8.9 released

v1.8.8

60b7351

2018-12-17 14:56

swagger-bootstrap-ui 1.8.8 发布，Swagger增强UI 实现

最后提交信息为：标题修改

v1.8.7

2f5a256

2018-11-11 22:38

swagger-bootstrap-ui 1.8.7 发布，Swagger增强UI 实现

Swagger-Bootstrap-Ui 1.8.7 发布了。Swagger-Bootstrap-Ui是 Swagger 的增强UI 实现，目的是替换 Swagger 默认的 UI 实现 Swagger-UI，使文档更友好一点儿

从1.0到更新至今,Swagger-Bootstrap-Ui也新增了很多小特性,为使更多人了解她,我重写了一份关于Swagger-Bootstrap-Ui的文档说明.希望越来越多使用她的用户都能体验到她带来的便利.详情可关注README.MD

Swagger-Bootstrap-Ui 1.8.7 主要更新如下：

特性&优化

1、优化调试框响应内容高度,根据响应内容自动设置响应高度,不再设固定高度.

2、Authorize功能提供注销功能,清空当前缓存在浏览器的相关Auth信息.

3、新增Swagger Models菜单项功能,以TreeTable的方式展示当前Swagger分组实例文档中所有相关的Models属性说明.

4、个性化配置项新增是否显示tag分组description属性的选择项,勾选后,会和swagger官方文档一样显示description属性,默认为false不显示.

5、引入async.js异步组件库,优化文档解析效率,解析渲染速度提升5倍以上.

6、优化接口的id生成策略,使用MD5针对接口地址和mehtod方式生成接口id,调试参数全局缓存localStorage对象中,方便下次刷新访问调试.

7、响应状态栏增加全屏icon,点击全屏icon可全屏查看响应内容.

8、解决离线文档再开启UI增强功能后不排序的问题

9、调试框根据Swagger接口参数显示当前接口的Content-Type类型,在某些特殊情况下可更改默认定义Content-Type请求头类型,如果使用UI提供的全局参数功能,自定义了Content-Type的请求头,则默认以全局参数中的Content-Type为主.

10、增加对JSR-303 annotations 注解的支持(部分)

Bug修复

1、针对SpringCloud通过网关构建Swagger分组获取不到Documentation对象的情况,根据default再获取一次

2、修复UI增强关于使用@Api注解tags属性不赋值,使用value，增强排序失败的问题.

3、修复针对@RequestMapping注解无value属性,UI增强出现数组越界的问题

4、修复针对扩展Spring的RequestMappingHandlerMapping自定义实现方式,获取不到扩展接口url地址信息,导致UI增强排序失败的问题.

项目地址

Maven坐标

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

最后提交信息为： 1.8.7 released

v1.8.6

e81b4b3

2018-10-31 13:46

swagger-bootstrap-ui 1.8.6 发布，Swagger增强UI 实现

最后提交信息为： 1.8.6 released

v1.8.5

98e2b33

2018-10-16 10:13

swagger-bootstrap-ui 1.8.5 发布，Swagger增强UI 实现

swagger-bootstrap-ui 1.8.5 发布了。swagger-bootstrap-ui 是 Swagger 的增强UI 实现，目的是替换 Swagger 默认的 UI 实现 Swagger-UI，使文档更友好一点儿

swagger-bootstrap-ui在1.8.5以后,她不在是一个纯webjar的UI工具了,她增强了swagger的一些功能支持,例如tags、接口的排序,一些个性化的支持,目前只增强接口排序

后续更多关于swagger的增强功能需求非常欢迎大家提[issue](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/new?issue%5Bassignee_id%5D=0&issue%5Bmilestone_id%5D=0)反馈,让这款UI更加丰富强大.

swagger-bootstrap-ui 1.8.5 主要更新如下：

1、fixed formdata类型参数针对array数组类型无增加按钮

2、fixed 响应内容高度占比,参数过多的情况无法显示

3、多选项卡文档介绍、在线调试position位置引起的不适改动,由竖变横.

4、增强排序功能，添加个性化配置管理功能,可开启个性化配置

5、关于个性化增强功能,目前已经实现了tags、和接口api方法的排序,使用方式：

在原`EnableSwagger2`注解上增加`@EnableSwaggerBootstrapUi`注解

```java
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class SwaggerConfiguration {
 	//more...   
}
```

针对tags分组排序，UI的排序规则是顺序排序，最小值1，最大值也是默认值Integer.Max_VALUE;

如果不使用SwaggerBootstrapUi的增强功能,则无需开启`@EnableSwaggerBootstrapUi`注解

**tags的排序规则分两种**：

a、一种是判断Swagger的`@Api`注解的position属性是否不等于0（默认值为0），如果该值不为空,则获取此值,根据该值排序

b、如果postion=0（不写的情况下）,判断是否存在注解`@ApiSort`的值，如果有值，则获取此值,根据该值排序

c、所以排序的取值规则是：position>@ApiSort

**接口api的排序规则**：

a、判断`@ApiOperation`注解上的postion属性是否不等于0（默认值为0），如果该值不为空,则获取此值,根据该值排序

```java
//postion属性赋值
@ApiOperation(httpMethod = "POST",position = 2,value = "Test2Model测试数组参数，多个",response=Test2Model.class)
@ApiResponses({
    @ApiResponse(code = 200, message = "非HTTP状态码，返回值JSON code字段值，描述：成功")
})
@ApiImplicitParams({
    @ApiImplicitParam(name = "ids",paramType ="form",value = "参数",allowMultiple = true, required = true)
})
```

b、如果postion=0（不写的情况下）,判断是否存在注解`@ApiOperationSort`的值，如果有值，则获取此值,根据该值排序

c、所以排序的取值规则是：position>@ApiOperationSort

**注意**：

注解`@EnableSwaggerBootstrapUi`、`@ApiSort`、`@ApiOperationSort`是本UI工具包提供的Java注解,排序功能的使用需要在启用原`EnableSwagger2`注解上增加`@EnableSwaggerBootstrapUi`注解方可生效

6、默认去除接口api地址的线上,默认只显示方法类型、方法说明两个属性,当然,新版本增加的个性化的配置功能，如果你觉得api地址显示任然有需要,可在个性化配置中开启该功能，个性化配置属性存储在localStorage对象中.只需要配置一次接口.

7、fixed 构建curl功能中写死http,根据`window.location.href`动态判断(http|https)的情况

8、如果请求参数是json参数body类型，文档说明中添加**请求示例**json展示,方便查看

9、请求示例、响应示例json自动适配高度

10、选中接口api菜单时,菜单显示激活色,显示背景颜色background-color: #eee;

11、fixed 离线文档markdown格式错乱问题(table标题换行导致显示异常)

12、离线文档已预览html的方式展现,复制文档功能依然是复制markdown语法

13、请求参数及响应参数说明改为多行显示,超出长度不以省略号显示,防止出现浮层一直显示的bug

**Maven坐标**

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

最后提交信息为： change chines comment

v1.8.4

933638b

2018-09-25 14:01

swagger-bootstrap-ui 1.8.4 发布，Swagger前端 UI 实现

swagger-bootstrap-ui 1.8.4 发布了。swagger-bootstrap-ui 是 Swagger 的前端 UI 实现，目的是替换 Swagger 默认的 UI 实现 Swagger-UI，使文档更友好一点儿

swagger-bootstrap-ui 1.8.4 主要更新如下：

1、fixed key-value表单请求 @RequestParam映射无效,在线调试bug[issue #IMXOV @Gitee](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IMXOV)、[issue #30 @GitHub](https://github.com/xiaoymin/Swagger-Bootstrap-UI/issues/30)

2、fixed 树形model默认展开[issue #IMXH5 @Gitee](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IMXH5)

3、fixed 两个list里放同一个bean，一个显示一个不显示[issue #IMXOY @Gitee](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IMXOY)

4、fixed 同时传输文本信息和文件时，值重复[issue #IMXDT @Gitee](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IMXDT)

5、fixed issue [#IN03Q](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IN03Q)

6、fixed 响应类 3层嵌套解析不出来[issue #IMXOF @Gitee](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IMXOF)

7、fixed 全局参数设置接口中已有变量,会导致在线调试里面出现2个参数,不方便调试(如果后端swagger配置文件中使用globalParameter设置全局参数，并且赋予默认值，则以后端全局参数值为准)[issue #IMXVD @Gitee](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IMXVD)

8、fixed ["text/plain"] controller接收问题[issue #IN0PC @Gitee](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IN0PC)

9、优化调试页响应高度，ace-editor响应高度

10、默认在Swagger-bootstrap-ui的请求,UI会增加一个默认的请求头`Request-Origion`:`SwaggerBootstrapUi`

11、fixed Authorize默认tab不选中的bug

12、fixed curl响应参数,针对中文urlencode处理

**Maven坐标**

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

最后提交信息为：删除无效js

v1.8.3

6409c24

2018-09-17 12:47

swagger-bootstrap-ui 1.8.3 发布，Swagger前端 UI 实现

最后提交信息为： Merge remote-tracking branch 'origin/master'

v1.8.2

26062b6

2018-08-26 18:05

swagger-bootstrap-ui 1.8.2 发布，Swagger前端 UI 实现

swagger-bootstrap-ui 1.8.2 发布了。swagger-bootstrap-ui 是 Swagger 的前端 UI 实现，目的是替换 Swagger 默认的 UI 实现 Swagger-UI，使文档更友好一点儿

swagger-bootstrap-ui 1.8.2 主要更新如下：

1、fixed 关于@ApiModelProperty的value不支持\n [issue #IM7XC @GITEE](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IM7XC)

2、fixed 关于在线调试界面显示的优化,调试栏新增参数类型列,区分数据参数请求类型 [issue #IM7TV @GITEE](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IM7TV)

3、fixed 在springcloud下 整合到zuul时 测试路径不正确[issue #IM69X @GITEE](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IM69X)

4、属性介绍说明，表格栏统一使用中文

5、fixed 发布到tomcat非root目下时路径被多层嵌套curl路径正确 ui内部测试路径多层[issue #IM69H @GITEE](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IM69H)

6、fixed List<String>和String[]类型解析不正确，应该为array，实际为String并且不能增加[issue #IM2ZI @GITEE](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IM2ZI)

7、fixed 类型及引用类在出现array类型时不一致的问题[issue #7 @GitHub](https://github.com/xiaoymin/Swagger-Bootstrap-UI/issues/17)

8、fixed DELETE请求无法正确处理请求头[issue #16 @GitHub](https://github.com/xiaoymin/Swagger-Bootstrap-UI/issues/16)

9、fixed 在线调试-参数名称更改不生效 [issue #IMBN3 @GITEE](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IMBN3)

10、fixed 升级到1.8.1后,火狐浏览器无法显示文档[issue #IM37D @GITEE](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IM37D)

11、fixed 关于请求是form表单，但是业务参数是body(json体的)请求异常[issue #IM2YE @GITEE](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IM2YE)

12、fixed 入参中的对象被处理成string[issue #ILU3S @GITEE](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/ILU3S)

13、fixed UI 样式建议(采纳大部分建议，非常感谢@永夜 提出的建议)[issue #IMCET @GitEE](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IMCET)

14、fixed 当请求，出现param参数时，与body参数时，传到服务器无效params没有传,同issue #IM2YE [issue #IM72N @GITEE](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IM72N)

15、优化，返回raw文本标签页添加复制文本功能,方便开发者调用，复制按钮增加icon

16、fixed 文件上传的bug[issue #IM4RG @GITEE](https://gitee.com/xiaoym/swagger-bootstrap-ui/issues/IM4RG)

**Maven坐标**

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

最后提交信息为： 1.8.2 released