swagger-bootstrap-ui 1.7.5 发布了。swagger-bootstrap-ui 是 Swagger 的前端 UI 实现,目的是替换 Swagger 默认的 UI 实现 Swagger-UI,使文档更友好一点儿
本版本,swagger-bootstrap-ui核心JS组件进行重构,新版本中,文档呈现将剔除原table的展现方式,以markdown格式展现
swagger-bootstrap-ui 1.7.5 主要更新如下:
- 重构DApiUI.js功能,新版本使用SwaggerBootstrapUi.js,方便后期扩展,同时删除无效js、css、html文件,新版本jar包由原760kb缩小至295kb
- 重构文档页面,剔除原来table展现方式,新版本使用markdown格式展现文档,单个文档页可复制
- 新增全局参数配置功能,针对请求参数有全局参数情况下,方便在线调试
- 支持离线文档格式,生成markdown格式文档,供开发者对外生成静态文档
通过markdown转换工具Typora预览效果
Typora导出pdf预览效果
- 添加clipboard插件,离线文档可复制功能
- 正式发布版去除console打印调试信息
- fixed 调试页面去除url根路径/,项目名称非ROOT,或分布式情况下路径不对,多一个"/"的问题
- fixed RequestBody 接收实体对象,对象属性中有List属性时,参数显示array,需解析对象属性显示,方便查看
- fixed 对象属性展示为string,属性未显示
- tip:推荐使用chrome浏览器,别的浏览器可能有js、css兼容问题,文档效果未到最佳
Maven坐标
<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-ui</artifactId> <version>1.7.5</version> </dependency>
还未给swagger-bootstrap-ui点过赞的朋友,前往https://gitee.com/xiaoym/swagger-bootstrap-ui给个Star吧~~ :)
引用来自“CRongL”的评论
楼主,有个小问题,@Bean
public Docket docketEnterprise() {
return applySecurity(new Docket(DocumentationType.SWAGGER_2)
.apiInfo(new ApiInfoBuilder()
.title("企业模块文档")
.description("企业模块文档")
.contact(new Contact("test", "", "test@qq.com"))
.version("1.0.0")
.build())
//.groupName("企业模块")
.select().apis(RequestHandlerSelectors.basePackage("com.test.b2b.modules.shop.controller")).paths(PathSelectors.any())
.build());
}
, //.groupName("企业模块") 定义的时候 如果设置了 groupName , 无法获取 到 json数据源 ,swagger 的json数据是这样来的, http://xxxxx/v2/api-doc?group="企业模块" , 所以页面就直接取不到了 ! 如果不设置group,只加载一个模块
,http://xxxxx/v2/api-doc 是可以加载接口到页面 ,但是如果 我把 扫描的包设置到模块顶层 com.test.b2b.modules 项目的接口 返回的数据量很大, 页面就渲染不出来了, F12 可以看到 network 有数据返回 , 数据量有400k 左右 , 如果方便可以联系我 qq:517129102
引用来自“八一菜刀”的评论
可以加群 讨论一下:608374991引用来自“CRongL”的评论
楼主,有个小问题,@Bean
public Docket docketEnterprise() {
return applySecurity(new Docket(DocumentationType.SWAGGER_2)
.apiInfo(new ApiInfoBuilder()
.title("企业模块文档")
.description("企业模块文档")
.contact(new Contact("test", "", "test@qq.com"))
.version("1.0.0")
.build())
//.groupName("企业模块")
.select().apis(RequestHandlerSelectors.basePackage("com.test.b2b.modules.shop.controller")).paths(PathSelectors.any())
.build());
}
, //.groupName("企业模块") 定义的时候 如果设置了 groupName , 无法获取 到 json数据源 ,swagger 的json数据是这样来的, http://xxxxx/v2/api-doc?group="企业模块" , 所以页面就直接取不到了 ! 如果不设置group,只加载一个模块
,http://xxxxx/v2/api-doc 是可以加载接口到页面 ,但是如果 我把 扫描的包设置到模块顶层 com.test.b2b.modules 项目的接口 返回的数据量很大, 页面就渲染不出来了, F12 可以看到 network 有数据返回 , 数据量有400k 左右 , 如果方便可以联系我 qq:517129102
@Bean
public Docket docketEnterprise() {
return applySecurity(new Docket(DocumentationType.SWAGGER_2)
.apiInfo(new ApiInfoBuilder()
.title("企业模块文档")
.description("企业模块文档")
.contact(new Contact("test", "", "test@qq.com"))
.version("1.0.0")
.build())
//.groupName("企业模块")
.select().apis(RequestHandlerSelectors.basePackage("com.test.b2b.modules.shop.controller")).paths(PathSelectors.any())
.build());
}
, //.groupName("企业模块") 定义的时候 如果设置了 groupName , 无法获取 到 json数据源 ,swagger 的json数据是这样来的, http://xxxxx/v2/api-doc?group="企业模块" , 所以页面就直接取不到了 ! 如果不设置group,只加载一个模块
,http://xxxxx/v2/api-doc 是可以加载接口到页面 ,但是如果 我把 扫描的包设置到模块顶层 com.test.b2b.modules 项目的接口 返回的数据量很大, 页面就渲染不出来了, F12 可以看到 network 有数据返回 , 数据量有400k 左右 , 如果方便可以联系我 qq:517129102
引用来自“bako”的评论
参数是否必须设置无效。ApiModelProperty.required属性设置为true,页面是否必须还是false
swagger_version='2.9.2'
引用来自“anxinxx”的评论
赞一个引用来自“anxinxx”的评论
要是侧边接口栏大小可以拖动就更加完美了。@八一菜刀ApiModelProperty.required属性设置为true,页面是否必须还是false
swagger_version='2.9.2'
引用来自“ifu25”的评论
有C#版吗?