Swagger-Bootstrap-Ui 1.8.7 发布,Swagger增强UI 实现

八一菜刀
 八一菜刀
发布于 2018年11月12日
收藏 43

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增强排序失败的问题.

UI效果展示

 

 

项目地址

Maven坐标

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.8.7</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

Star & Issue

或许她不是最漂亮的SwaggerUi,但绝对是目前最实用的SwaggerUi

前往https://gitee.com/xiaoym/swagger-bootstrap-ui点个Star吧~~ :)

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处,尊重他人劳动共创开源社区。
转载请注明:文章转载自 OSCHINA 社区 [http://www.oschina.net]
本文标题:Swagger-Bootstrap-Ui 1.8.7 发布,Swagger增强UI 实现
加载中

最新评论(7

程序人生2015
程序人生2015
想法不错,UI确实需要改善
ZigzagV
ZigzagV

引用来自“ZigzagV”的评论

主打ui,又没有好好设计。脸太重要了。

引用来自“八一菜刀”的评论

即使有最好看的UI,也会有人吐槽不好看,这是用户个人问题,本身并没有主打UI,一直说的是文档展示友好一些,这个你可以去看历史的新闻,并没有觉得被打脸,你用过原版 和这个 自己会有体会.至于你说的设计,可能确实没考虑周到,更多的是考虑功能。或者你有更好的意见,也欢迎反馈。
脸指的是ui设计,支持无私的开源项目。
ZigzagV
ZigzagV

引用来自“ZigzagV”的评论

主打ui,又没有好好设计。脸太重要了。

引用来自“八一菜刀”的评论

即使有最好看的UI,也会有人吐槽不好看,这是用户个人问题,本身并没有主打UI,一直说的是文档展示友好一些,这个你可以去看历史的新闻,并没有觉得被打脸,你用过原版 和这个 自己会有体会.至于你说的设计,可能确实没考虑周到,更多的是考虑功能。或者你有更好的意见,也欢迎反馈。
没别的意思。我想表达的是,一个ui比较好看的项目比较容易推广。并不否认这个项目跟自带的ui比的确功能强大方便了很多,非常值得使用的。
八一菜刀
八一菜刀

引用来自“ZigzagV”的评论

主打ui,又没有好好设计。脸太重要了。
即使有最好看的UI,也会有人吐槽不好看,这是用户个人问题,本身并没有主打UI,一直说的是文档展示友好一些,这个你可以去看历史的新闻,并没有觉得被打脸,你用过原版 和这个 自己会有体会.至于你说的设计,可能确实没考虑周到,更多的是考虑功能。或者你有更好的意见,也欢迎反馈。
ZigzagV
ZigzagV
主打ui,又没有好好设计。脸太重要了。
光脚满地跑
光脚满地跑

引用来自“阿舍s”的评论

择日升级😛
择日不如撞日,那就今天吧❤
阿舍s
阿舍s
择日升级😛
返回顶部
顶部