Swagger Bootstrap Ui Versions Save

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>

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

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

特性增加

1、请求参数类型(header|body|query)等以不同颜色着色区分

2、调试栏针对必须项(require=true)时,文本框着红色以区分

3、调试页输入框可通过tab键自动切换上下级输入框.

Bug修复

1、修复Spring使用cglib生成的代理类,导致class无法获取Spring的相关注解,导致接口增强排序失败

2、针对basePath属性不是根路径“/”，导致接口排序比对失败，无法排序的问题

3、修复针对SpringCloud通过zuul路由组件加载swagger接口存在basePath属性,增强接口缺失basePath属性的bug,导致增强接口请求失败的问题

4、修复Spring的请求地址仅支持value属性，不支持path属性的bug

5、针对请求头Content-Type中多余空格问题,部分接口调用失败的问题

6、修复针对参数、参数说明太长,导致table换行，样式失效问题.

7、修复针对header、path等参数外，传参只包含body类型无请求json示例的问题.

8、修复针对请求参数存在多个数组,增加按钮无效的BUG.

9、优化离线文档相关的显示格式问题.包括JSON显示格式错乱、添加请求JSON示例、文档开始说明等信息

Maven坐标

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

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反馈,让这款UI更加丰富强大.

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

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

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

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

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

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

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

@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），如果该值不为空,则获取此值,根据该值排序

//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>

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映射无效,在线调试bugissue #IMXOV @Gitee、issue #30 @GitHub

2、fixed 树形model默认展开issue #IMXH5 @Gitee

3、fixed 两个list里放同一个bean，一个显示一个不显示issue #IMXOY @Gitee

4、fixed 同时传输文本信息和文件时，值重复issue #IMXDT @Gitee

5、fixed issue #IN03Q

6、fixed 响应类 3层嵌套解析不出来issue #IMXOF @Gitee

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

8、fixed ["text/plain"] controller接收问题issue #IN0PC @Gitee

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>

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

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

1、新增tab选项卡,各个api接口详情通过新开选项卡来展现

2、去除原schema表格形式展示，请求参数、响应参数改由treetable组件(树组件)展示

3、fixed 请求参数有array类型,显示为schema类型的bug

4、fixed springcloud zuul 整合ui情况下 地址多个/ISSUE #IMF0L @Gitee

5、响应内容去除cookies选项卡，响应示例、响应内容使用ace-editor展示响应内容，方便复制

6、优化(全局参数&Authorize)加入浏览器缓存问题,使用localStorage对象全局存储issue #IMH77 @Gitee

7、fixed 泛型数据接口返回list类型时，不能解析issue #26 @GitHub

8、fixed 模型内部包含模型没有展示issue #25 @GitHub

9、优化请求参数是否必填样式,如果该参数必填,则以红色标注显示issue #22 @Github

10、fixed DELETE请求不能正确处理Query参数 issue #19 @GitHub

11、fixed 请参数类型为 formData 的参数，填写了参数值还是提示 参数不能为空issue #24 @GitHub、issue #IMMMJ @Gitee

12、优化离线文档多行，换行、多空格显示问题

Maven坐标

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

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

2、fixed 关于在线调试界面显示的优化,调试栏新增参数类型列,区分数据参数请求类型 issue #IM7TV @GITEE

3、fixed 在springcloud下 整合到zuul时 测试路径不正确issue #IM69X @GITEE

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

5、fixed 发布到tomcat非root目下时路径被多层嵌套curl路径正确 ui内部测试路径多层issue #IM69H @GITEE

6、fixed List<String>和String[]类型解析不正确，应该为array，实际为String并且不能增加issue #IM2ZI @GITEE

7、fixed 类型及引用类在出现array类型时不一致的问题issue #7 @GitHub

8、fixed DELETE请求无法正确处理请求头issue #16 @GitHub

9、fixed 在线调试-参数名称更改不生效 issue #IMBN3 @GITEE

10、fixed 升级到1.8.1后,火狐浏览器无法显示文档issue #IM37D @GITEE

11、fixed 关于请求是form表单，但是业务参数是body(json体的)请求异常issue #IM2YE @GITEE

12、fixed 入参中的对象被处理成stringissue #ILU3S @GITEE

13、fixed UI 样式建议(采纳大部分建议，非常感谢@永夜 提出的建议)issue #IMCET @GitEE

14、fixed 当请求，出现param参数时，与body参数时，传到服务器无效params没有传,同issue #IM2YE issue #IM72N @GITEE

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

16、fixed 文件上传的bugissue #IM4RG @GITEE

Maven坐标

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

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

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

1、fixed 针对basePath属性,调试接口重复添加basePath路径,接口报404错误(重大bug,建议升级)

2、fixed 针对@ApiModelProperty注解,针对example属性值,array类型值带单引号,文档无法显示bug

3、fixed 针对404 异常,header-curl tab选项卡切换bug

4、fixed curl -X 参数bug,显示缺少"/"根路径

5、fixed 左侧接口列表滚条无法完全滚动到底部

6、fixed 窗口大小改变后，界面混乱

7、优化菜单做成接口方法类型和接口类型左对齐

8、fixed 左侧接口列表滚条无法完全滚动到底部

9、优化 针对枚举类型,参数说明显示可用值列表

10、表单类型显示header、可提交header信息

11、fixed 基础类型响应数据为空的情况

Maven坐标

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

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

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

1、fixed 请求参数出现重复问题,去重

2、fixed 无法显示spring cloud 子项目路径,针对basePath不为空,或者不为"/"根路径的情况,相关api地址加上basePath前缀

3、调整菜单url各方法配色、接口配色,文档介绍、调试返回响应数据json配色

4、响应模块添加http响应码、接口耗时、大小,参数栏添加全选按钮,调试页面针对响应内容tab选项卡去除灰色背景色,为默认白色底色

5、调试响应模块增加raw、curl两个子tab选项卡,实现curl功能,方便远程调试

6、针对接口二进制返回,提供下载按钮,可点击弹出下载功能

7、fixed 针对图片返回时报DApiUI is not defined错误

8、文档doc.html页面title根据用户自定义title显示

9、发送中增加loading效果

10、调整菜单顶部分组接口位置,移动到最左侧,添加可隐藏/显示MENU元素

11、fixed 针对schema类型的参数,显示类型为string类型,按schema类型展示

12、文件上传支持文件多选

Maven坐标

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

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

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

1、fixed 针对Integer、double、float等类型参数,有format参数则显示format属性,以区分准确类型,如：int64|int32等

2、fixed 滚动条出现底部部分内容不显示bug

3、优化菜单接口根据不同接口类型,颜色调整

4、优化文档响应数据jsonview字体,优化间距,更显紧促,优化菜单,接口及接口类型加粗

5、add 顶部加搜索功能、可根据api地址、api介绍、api类型、分组名称实现模糊搜索,默认搜索当前已加载的分组api,如果其他分组未加载则搜索不到.

6、add 针对Security-JWT等权限验证,显示Authorize菜单授权

7、add 左侧菜单栏可自由拖动长度大小

Maven坐标

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

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

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

1、fixed 针对@RequestBody注解实体类属性required的值一直显示默认false问题

2、fixed 针对文件上传,使用allowMultiple = true,上传按钮不显示bug,推荐使用@ApiImplicitParam注解,并且指定dataType = "MultipartFile"

3、分组接口移动至顶部,菜单列表添加icon图标,移除简介页的软件介绍信息,丰富简介页信息,新增各类型接口统计信息,菜单简介名称更名为主页

4、增加调试参数记忆功能,下次点击该接口时,上次输入的参数会保存继续可使用

5、优化 针对@RequestBody注解,参数使用默认description的问题,将使用@ApiModel注解实体类上的description属性

Maven坐标

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