swagger-bootstrap-ui 1.9.4 发布,扩展支持动态字段注释

八一菜刀
 八一菜刀
发布于 2019年06月10日
收藏 42

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 @Gitee

6、增加调试接口响应类型为Xml、Html、Text的支持#IWP49 @Gitee

7、优化调试后header、raw、curl等选项卡高度太低的问题#IWLSU @Gitee

8、主页简介description字段支持markdown格式#IVVRX @Gitee

9、针对枚举类型的集合类型(List),在字段描述中显示枚举可用列表值#100 @GitHub

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

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

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

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

UI效果展示

项目地址

Maven坐标

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

Star & Issue

感谢各位朋友的支持,前往https://gitee.com/xiaoym/swagger-bootstrap-ui点个Star吧~~ :)

源码分析

距离上一个版本也有挺长时间了,这段时间主要是对springfox的源码进行了一些研究和学习,并且记录了一些博客,该版本(1.9.4)的一些功能也在看源码的过程中对我有一些启发,对于Swagger的规范也多了一些了解

对springfox源码有兴趣的朋友可以去我的博客查看,点击前往

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处,尊重他人劳动共创开源社区。
转载请注明:文章转载自 OSCHINA 社区 [http://www.oschina.net]
本文标题:swagger-bootstrap-ui 1.9.4 发布,扩展支持动态字段注释
加载中

精彩评论

如梦技术
如梦技术
牛皮,非常实用

最新评论(12

s
spaceOSC123456
返回map或者json能用什么注释让前端可以知道返回什么字段?
八一菜刀
八一菜刀
@spaceOSC123456 返回都要用map是不是太过分了……
s
spaceOSC123456
返回的是对象,但对象的一个属性是list,list包含的是map
D
DevinHu
确实很强大
Mark哥是我
Mark哥是我
项目已使用
冷冷gg
冷冷gg
👍
Holt_Vong
Holt_Vong
怎么直接用YAML文件展示文档呢
八一菜刀
八一菜刀
要先转换成JSON,然后可以使用Chrome的扩展程序插件进行渲染
DolphinScheduler
DolphinScheduler
非常赞,我们EasyScheduler也是用这个做api doc的!
八一菜刀
八一菜刀
EasyScheduler也很强大,共勉😊
如梦技术
如梦技术
牛皮,非常实用
返回顶部
顶部