Metrics
0
Watch 349 Star 1.3K Fork 329

萧明 / swagger-bootstrap-uiJavaApache-2.0

2019-07-31 21:13
118100_xiaoym 萧明

swagger-bootstrap-ui 1.9.5 发布了。swagger-bootstrap-ui是 Swagger 的增强UI 实现,使文档更友好一点儿

文档:http://doc.xiaominfo.com

效果:http://swagger-bootstrap-ui.xiaominfo.com/doc.html

Gitee:https://gitee.com/xiaoym/swagger-bootstrap-ui

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

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

特性&优化

1、针对文件上传响应JSON内容时,内容不高亮的问题#IYXZB:响应内容无高亮 版本1.94 @Gitee

2、文件上传响应内容显示异常Bug#IYO96 @Gitee

3、针对中文请求头使用encodeURIComponent()函数进行编码处理#IYMUF:请求头有中文报错 @Gitee

4、修复开启增强时空指针异常Bug#IYADU @Gitee

5、针对@ResponseHeader注解未显示Bug#IY86A @Gitee

6、DELETE请求针对Array类型的请求参数错误Bug#IY37Z @Gitee

7、修复GET请求时CURL响应栏参数拼装错误#131:是否可以添加一个变量之类的,自定义一下调试功能的显示? @adminchen

8、修复非200状态码响应内容不格式化高亮的问题#130:接口入参: list 点击增加 按钮,无效 @adminchen

9、解决地址显示的BUG, 确保请求能够正确发送出去#PR108 @adminchen

10、在使用动态扩展字段说明时,服务器上部署会造成空指针异常,该错误是由未对field名称进行非空判断导致#IYLVC:项目启动报空指针异常 @Gitee、#119 @adminchen

11、可以自定义动态过滤请求参数,这在很多时候可以让我少写实体类,比如新增的时候不需要id,修改时又需要id,只需要在接口层使用增强注解@ApiOperationSupport的ignoreParameters属性即可,具体使用规则请参考文档

12、优化增强排序接口注解@ApiSort无效果的问题

13、响应类Model动态添加解释字段.请参考文档

Maven坐标

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.5</version>
</dependency>
Last committed message: 1.9.5 RELEASED
2019-06-10 17:14
118100_xiaoym 萧明

swagger-bootstrap-ui 1.9.4 发布了。swagger-bootstrap-ui是 Swagger 的增强UI 实现,使文档更友好一点儿

文档:http://doc.xiaominfo.com

效果:http://swagger-bootstrap-ui.xiaominfo.com/doc.html

Gitee:https://gitee.com/xiaoym/swagger-bootstrap-ui

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

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

特性&优化

1、最低需要JDK 1.8支持

2、单独接口通过hash地址访问,方便开发人员之间快速复制传递接口信息,能准确定位到接口

3、优化下载参数名称问题,忽略filename大小写敏感#IXA5C:文件下载名称兼容问题 @Gitee

4、优化BasicFilter过滤器正则匹配频率问题,decode函数调用替换为JDK 1.8版本中的java.util.Base64

5、tab操作项修改为点击事件显示,避免同调试按钮冲突导致误关选项卡#IXA5I:右侧关闭tab菜单优化 @Gitee

6、增加调试接口响应类型为Xml、Html、Text的支持#IWP49:返回xml格式报错 @Gitee

7、优化调试后header、raw、curl等选项卡高度太低的问题#IWLSU:当返回值只有一行时header的高度太窄 @Gitee

8、主页简介description字段支持markdown格式#IVVRX:description不支持MarkDown语法 @Gitee

9、针对枚举类型的集合类型(List),在字段描述中显示枚举可用列表值#100:v1.8.2的 parameters 如果in参数是formData时, 字段是否填写判断有问题么? @adminchen

10、重构原接口排序、tag排序规则,新增接口作者属性,可写每个接口的作者,方便开发者调试.参考文档

11、针对Authorize授权的相关属性,不同分组相同的请求参数只需授权一次即可则全局通用#IXHBL @Gitee

12、针对Map、JSONObject等动态类型可通过自定义注解@ApiOperationSupport或者@DynamicParameters来增加参数的字段说明,解决不想写实体类的烦恼,但是又无文档的困扰.参考文档

13、优化自定义文档(markdown)界面效果,增加相关markdown语法样式(引用editormd.css)

2019-04-23 16:50
118100_xiaoym 萧明

swagger-bootstrap-ui 1.9.3 发布了。swagger-bootstrap-ui是 Swagger 的增强UI 实现,使文档更友好一点儿

文档:http://doc.xiaominfo.com

效果:http://swagger-bootstrap-ui.xiaominfo.com/doc.html

Gitee:https://gitee.com/xiaoym/swagger-bootstrap-ui

GitHub:https://github.com/xiaoymin/Swagger-Bootstrap-UI

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

特性&优化

1、增加i18n国际化支持(中文、English),可参考文档

2、优化调试框请求参数类型,添加数据类型issue #IVF2L:调试模块的参数类型显示错误 @Gitee

3、接口描述支持Html渲染issue #IVBWM:接口描述是否不支持html渲染 @Gitee

4、允许添加自定义文档(以markdown的形式)issue #IUWN9:功能建议,自定义左侧菜单,添加自定文档 @Gitee,可参考文档

5、优化非200状态码调试栏显示高度过低的情况.

6、分组tag名称很长时超出bug,增加菜单title鼠标悬浮显示分组tag名称issue #IVE0S:api文件名称过长会换行 @Gitee

7、初始化请求异常处理,弹出友好提示信息.

8、接口任何信息变更和新增接口一样,添加new的icon图表样式,代表当前接口信息已产生变化.

9、Swagger Models中的属性类显示readOnly|example属性issue #77:1.8.1文件上传的bug @adminchen

Bug修复

1、解决多个api文档切换时,Authorize的参数没有变更的bugissue #IV3OZ:多个api文档切换时,Authorize的参数没有变更 @Gitee

2、解决Basic认证出现的空指针异常以及账户密码为空的时候,页面崩溃的情况issue #78:全局参数与接口参数相同时会出现两个 相同参数 并且某一个为空 如图 @adminchen

Last committed message: 1.9.3.RELEASED
2019-04-08 08:51
118100_xiaoym 萧明

swagger-bootstrap-ui 1.9.2 发布了。swagger-bootstrap-ui是 Swagger 的增强UI 实现,使文档更友好一点儿

GitHub Gitee 文档 示例代码 在线体验

主要更新如下:

特性&优化

1、增加地址栏参数访问,快速个性化设置功能,可参考文档

2、修改SecurityConfiguration中关于Environment的注入方式,改为属性注解注入,提供默认无参构造,避免某些情况下使用SpringAop导致异常issue #ITI1C:SecurityConfiguration类没有默认构造方法导致出现SpringCGLIB错误 @Gitee

3、针对存在format属性字段类型,显示format属性,使参数更加清晰明了(例如:Integer-int32,Integer-int64,string-date)issue #ITIPQ:datatype类型建议是啥就是啥,不做转换,比如integer就显示integer,不展示为int(32) @Gitee

4、针对body类型的Array类型请求,给与默认参数值issue #ITVZ2:请求参数为数组时,设置example,不显示,请求示例中为[null] @Gitee

5、优化新接口图标太大的问题,解决下拉框选择分组后,title标题属性不切换的问题.issue #IUGWF:提两个优化建议 @Gitee

6、当请求参数太多(>5)时,调试栏显示折叠栏,点击发送后可自动折叠参数

7、图片预览显示高度自适应issue #72:升级到1.8.1后,火狐浏览器无法显示文档 @adminchen

8、针对@RequestBody类型的参数类型枚举的支持issue #73:运行demo出错 @adminchen

9、提供前后端分离的文档预览解决方案,具体参考文档

Bug修复

1、修复请求示例中支持readOnly属性issue #IS28O:example不显示 @Gitee

2、修复响应返回数据的Map类型数据无法展开显示issue #IUAXW:响应返回数据的Map类型数据无法展开显示&Deprecated的api能否加个标识? @Gitee

3、修复点击复制文档,复制的md文件中,没有接口名称issue #71:List<String>和String[]类型解析不正确,应该为array,实际为String并且不能增加 @adminchen

Last committed message: 文档完善
2019-03-11 11:27
118100_xiaoym 萧明

swagger-bootstrap-ui 1.9.1 发布了。swagger-bootstrap-ui是 Swagger 的增强UI 实现,使文档更友好一点儿

GitHub Gitee 文档 示例代码 在线体验

主要更新如下:

特性&优化

1、优化大数据响应接口,UI渲染卡顿,导致浏览器崩溃

2、ApiInfo.description支持htmlissue #65:1.8.0窗口大小改变后,界面混乱 @adminchen

3、合并pr#61,优化array子类型为基础类型时schema显示为空的情况

4、响应数据编辑器增加换行模式,针对响应某个字段特别长时,自动换行.

Bug修复

1、关闭默认响应状态后,自定义了@ApiResposes后,字段属性说明不显示issue #IRV1I:关闭默认响应状态后,自定义了@ApiResposes后,字段属性说明不显示 @Gitee

2、example不显示,支持readOnly属性issue #IS28O:example不显示 @Gitee

3、修复Authorize缓存bugissue #ITAST:Authorize出现缓存bug @Gitee

项目地址

Maven坐标

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

码云:https://gitee.com/xiaoym/swagger-bootstrap-ui

GitHub:https://github.com/xiaoymin/Swagger-Bootstrap-UI

在线体验:http://swagger-bootstrap-ui.xiaominfo.com/doc.html

项目文档:http://www.xiaominfo.com/swagger-bootstrap-ui/

Last committed message: 1.9.1 released
2019-02-25 08:48
118100_xiaoym 萧明

主要更新如下:

特性&优化

1、优化未给与tags分组时,Ui默认赋值default.

2、针对使用SwaggerBootstrapUi的增强排序功能时导致升级Springfox-Swagger必须升级到2.9.2引起的jar包冲突版本问题,Ui做向下兼容处理,Springfox-Swagger版本最低兼容2.7.0(相对稳定版本,亲测可用)

3、个性化新增配置,是否开启缓存已打开的api文档,感谢@web-xiaxia提交的pr

4、优化application/octet-stream下载出现的参数(header|query)问题

5、优化图片验证码显示问题,可参考文档文件下载及图片预览

6、新增权限特性属性swagger.production,开启此属性后会屏蔽swagger所有访问资源,可用于生产环境中部署屏蔽文档输出.保护文档安全,可参考文档访问权限控制

7、针对Swagger资源请求,提供Basic认证功能,可用于保护Swagger文档页面.可参考Basic详情

8、优化文件上传参数类型File的支持.可参考文档文件上传

9、优化响应数据右侧存在字段说明Span元素重叠,并增加Toggle开关显示关闭右侧字段说明

10、优化离线文档预览,超出UI默认接口数量(100个)时,自动显示markdown源文件代码,供开发者自动复制到第三方转换软件查看,不再提供预览效果

Bug修复

1、启用UI增强时,获取不到WebApplicationContext对象造成空指针异常

2、修复SpringMvc启用增强失败的Bug

3、修改对象属性设置example导致解析Model失败的bugissue #IROVN:引用对象不展示的问题 @Gitee

4、修复搜索后,相关个性化状态设置不显示的bugissue #IRE8W:搜索完后,原先设置的显示中文显示不了 @Gitee

5、修复 请求响应实体类内有Map类型参数无法正常显示 issue #IR61U:请求响应实体类内有Map类型参数无法正常显示 @Gitee

2019-01-11 17:30
118100_xiaoym 萧明

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

Swagger-Bootstrap-Ui 1.8.9 主要更新如下:

特性&优化

1、主页面添加页面不缓存元素,防止版本升级缓存造成新功能加载失败.

2、响应示例说明、调试响应内容行添加description说明字段,免去切换到文档说明看字段说明的麻烦,非常感谢@wanyaxing提交的PR

3、新增个性化配置-开启RequestMapping接口类型重复地址过滤,默认只显示POST类型的接口地址(针对RequestMapping的接口请求类型,在不指定参数类型的情况下,如果不过滤,默认会显示7个类型的接口地址参数,如果开启此配置,默认展示一个Post类型的接口地址)

4、针对application/octet-stream类型的接口提供下载调试.

Bug修复

1、启用UI增强时,获取不到WebApplicationContext对象造成空指针异常

2、修复list套list的返回值会不显示issue #55:如何将多个微服务的api整合到一个地址里面? @adminchen

3、接口请求参数同全局参数配置名称存在冲突的情况下,根据名称匹配导致参数丢失,匹配规则为参数名称、参数类型同时比较issue #IQV1U:参数丢失(全局里定义一个header的参数为uid,然后接口里有个uid,然后在请求参数里接口的uid不见了。) @Gitee

4、服务端响应HTML标签数据时,响应内容显示异常issue #IQ9LG:请求返回带<img标签时,不显示 @Gitee

5、修复参数格式问题issue #IPXX7:模拟请求的参数格式不对,字符串变成了数字 @Gitee

6、针对多响应码返回不同schema类型,离线文档(markdown)未展示完整的bugissue #IPPHJ:响应状态返回不正确 @Gitee

项目地址

Maven坐标

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.8.9</version>
</dependency>
Last committed message: 1.8.9 released
2018-12-17 14:56
118100_xiaoym 萧明

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

Swagger-Bootstrap-Ui 1.8.8 主要更新如下:

特性&优化

1、顶部标题可自定义,去除原默认显示swagger-bootstrap-ui的固定标题,title规则为获取分组对象apiInfo中的第一个title属性

2、个性化配置中新增是否开启请求参数缓存策略,默认为true,当设置为false时,请求的参数不会再本地产生缓存,下次打开接口调试时需要自己重新输入相关接口参数

3、分组加载由同步改为异步加载

4、新增接口高亮显示,当后端新增接口后,UI会自动标识该接口为新接口,直到该接口被点击为止.

5、当服务器正在重启或者宕机时,接口发生异常,给出友好提示,告知接口对接人员.

6、请求参数必填排序,require=true排最前

7、后端接口方法上针对@Deprecated标注的接口,UI以中横线标注区分

8、针对不同状态响应码,返回内容均有Schema的情况下,UI以tab方式将所有状态码的schema内容呈现

9、优化接口数量过多的情况下,离线文档会导致文档页假死

Bug修复

1、修复针对Delete请求,使用@RequestBody注解出现400错误 issue IPLJT @Gitee

2、修复响应状态码HTML标签非转义输出 issue #47:请问作者,这个支持swagger的OAuth2相关的操作吗? @adminchen

3、不能正确解析response内非$ref的schema内容 issue #43:参数对象里属性加了required=true,文档上是否必须列依然是false @adminchen

项目地址

Maven坐标

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.8.8</version>
</dependency>
Last committed message: 标题修改
2018-11-11 22:38
118100_xiaoym 萧明

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>
Last committed message: 1.8.7 released
2018-10-31 13:46
118100_xiaoym 萧明

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示例、文档开始说明等信息

UI效果展示

Maven坐标

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.8.6</version>
</dependency>
Last committed message: 1.8.6 released
2018-10-16 10:13
118100_xiaoym 萧明

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>
Last committed message: change chines comment
2018-09-25 14:01
118100_xiaoym 萧明

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:1.8.3版本@RequestParam映射无效 @Gitee issue #30:使用聚合文档在线调试都是500错误 @adminchen

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

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

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

5、fixed issue #IN03Q:接口调试的时候,1.8.3版本报url参数必填,1.8.2版本报post参数必填(实际已填)。

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

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

8、fixed ["text/plain"] controller接收问题issue #IN0PC:["text/plain"] controller接收问题 @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>
Last committed message: 删除无效js
2018-09-17 12:47
118100_xiaoym 萧明

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:springcloud zuul 整合ui情况下 地址多个/ @Gitee

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

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

7、fixed 泛型数据接口返回list类型时,不能解析issue #26:Result<T>这种统一相应实体希望能支持 @adminchen

8、fixed 模型内部包含模型没有展示issue #25:globalResponseMessage 不显示 @adminchen

9、优化请求参数是否必填样式,如果该参数必填,则以红色标注显示issue #22:description: "报文体", $ref: "#/definitions/MockBaseVO" 无法解析请求报文和响应报文。 @adminchen

10、fixed DELETE请求不能正确处理Query参数 issue #19:分组的支持什么时候能帮做到兼容啊 @adminchen

11、fixed 请参数类型为 formData 的参数,填写了参数值还是提示 参数不能为空issue #24:如果嵌套响应集合在此模版里不会显示 @GitHub、issue #IMMMJ:v1.8.2的 parameters 如果in参数是formData时, 字段是否填写判断有问题么? @Gitee

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

Maven坐标

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.8.3</version>
</dependency>
2018-08-26 18:05
118100_xiaoym 萧明

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:关于@ApiModelProperty的value不支持\n @Gitee

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

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

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

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

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

7、fixed 类型及引用类在出现array类型时不一致的问题issue #7:支持HTTP的PUT和DELETE方法 @adminchen

8、fixed DELETE请求无法正确处理请求头issue #16:[bug]存在参数是否必须的状态不对问题 @adminchen

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

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

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

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

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

14、fixed 当请求,出现param参数时,与body参数时,传到服务器无效params没有传,同issue #IM2YE:关于请求是form表单,但是业务参数是body(json体的)请求异常 issue #IM72N:当请求,出现param参数时,与body参数时,传到服务器无效params没有传,如图 @Gitee

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

16、fixed 文件上传的bugissue #IM4RG:1.8.1文件上传的bug @Gitee

Maven坐标

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.8.2</version>
</dependency>
Last committed message: 1.8.2 released
2018-08-14 10:06
118100_xiaoym 萧明

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>
Last committed message: 1.8.1 released
2018-08-10 11:33
118100_xiaoym 萧明

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>
Last committed message: 1.8.0 released
2018-08-06 10:57
118100_xiaoym 萧明

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>
Last committed message: 1.7.9 released
2018-08-03 13:32
118100_xiaoym 萧明

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>
Last committed message: 1.7.8 released
2018-07-25 13:38
118100_xiaoym 萧明

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

该版本基本是fixed版本,修复了很多bug,针对全局参数这种新特性,影响比较大,建议升级

swagger-bootstrap-ui 1.7.7 主要更新如下:

1、fixed 对象ref应用本身,JS 出现死循环了么,栈内存溢出BUG

2、优化递归查找ref方法,fixed ref自身引用,相互引用的情况下,文档出不来bug

3、响应json属性太多,文档太长,不利于查看,使用jsonview插件格式化,可收缩,便于查看

4、fixed 对象属性值存在required属性时,值显示不对bug

5、兼容firefox,文档菜单换行显示异常问题

6、新增枚举请求参数类型支持,调试页面枚举类型为下拉框

7、fixed 请求swagger-resources接口响应为string类型,文档无法展示,格式化json展示文档

8、fixed 全局参数重新赋值无效

9、fixed 针对@ApiOperation注解自定义tags接口无法显示bug

Maven坐标

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.7.7</version>
</dependency>
Last committed message: close print infomation
2018-07-18 15:36
118100_xiaoym 萧明

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

该版本基本是fixed版本,修复了很多bug,针对全局参数这种新特性,影响比较大,建议升级

swagger-bootstrap-ui 1.7.6 主要更新如下:

1、fixed 全局默认参数,设置值无效问题

2、add 简介页添加basePath属性

3、fixed 响应类型是Ref引用属性,在响应json中未列出属性

4、fixed 默认值未显示,swagger 2.9.2版本响应json的默认值为x-example属性

5、fixed tags存在大写的情况不显示接口 bug,在swagger2.9.2版本测试时,swagger又将后台的tags改为区分大小写了,所以建议升级swagger版本到最新

6、fixed 相同url地址,不同method类型,接口未展示bug

7、fixed 请求参数为ref引用类型时,文档列出请求类型和schema类型一致,显示schema类型

8、tip:推荐使用chrome浏览器,别的浏览器可能有js、css兼容问题,文档效果未到最佳

9、tip:建议swagger版本升级到2.9.2

Maven坐标

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.7.6</version>
</dependency>
Last committed message: 1.7.6 released

Help Search