分享一个自己重写 swagger 的 ui 工具 swagger-bootstrap-ui

2018-09-28 09:03:34 +08:00
 xiaoymin

简介

swagger-bootstrap-uiSwagger的前端 UI 实现,目的是替换Swagger默认的 UI 实现Swagger-UI,使文档更友好一点儿....

swagger-bootstrap-ui 只是Swagger的 UI 实现,并不是替换Swagger功能,所以后端模块依然是依赖Swagger的,需要配合Swagger的注解达到效果

主要功能:

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

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

开源中国: https://gitee.com/xiaoym/swagger-bootstrap-ui

两大核心功能

9858 次点击
所在节点    分享创造
24 条回复
thisisgpy
2018-09-28 13:51:52 +08:00
已在公司推广使用,很不错。
xiaoymin
2018-09-28 15:19:21 +08:00
@thisisgpy 欢迎反馈意见~~~~
wangcansun
2018-09-28 15:59:15 +08:00
赞赞赞
wangcansun
2018-09-28 15:59:38 +08:00
我之前使用的是 material 的 swagger ui
wangcansun
2018-09-28 16:00:44 +08:00
run27017
2018-09-28 16:21:19 +08:00
顺便推广一下我的一个在线 Swagger Doc 编辑网站:

> https://run27.top/swaggerhuge

1. 支持团队私有化(本身就是设计成私有化的)
2. 支持团队协作(仿照 git 的模式,可以多人同时编辑不冲突)
3. 。。。

以前用的是国外的 swaggerhub,但是它的访问速度奇慢,翻墙后的速度也不太能接受。所以就自己写了一个。swaggerhub 的另一个问题是多人编辑不方便,会覆盖掉。最后的缺点就是收费了。

我目前只是在自己的团队内部推荐使用,并没有花力气推广。我觉得用 Swagger 写 API 可能有点小众。
solooo
2018-09-28 16:50:01 +08:00
已 Star, 赞
xiaoymin
2018-09-29 09:12:26 +08:00
@solooo 谢谢~~:)
xiaoymin
2018-09-29 09:12:52 +08:00
@wangcansun 可以使用这个看看:)
youngxhui
2018-09-29 10:12:01 +08:00
@wangcansun 这个好像无法继承到 java 里吧
wangcansun
2018-09-29 10:27:57 +08:00
@youngxhui 集成还是继承?
youngxhui
2018-09-29 10:28:50 +08:00
@wangcansun 不好意思 打错字了 是集成😁
wangcansun
2018-09-29 10:36:25 +08:00
@youngxhui 没试过,以前用的时候是单独写了个 nodejs 服务开管理文档
xiaoymin
2018-09-29 11:08:22 +08:00
@youngxhui 使用 springfox 的话可以直接使用,Java 开发在 pom 里面引入就可以了

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

其它语言暂时还没完善
xtaxcy
2018-10-04 12:29:34 +08:00
赞。适用一下。
wzw
2018-10-11 11:13:12 +08:00
@run27017 #6 可以一键测试吗
gam2046
2018-10-16 16:05:09 +08:00
真的很不错。不过可以对于页面宽度不足的情况下,调整一下布局嘛。

https://i.loli.net/2018/10/16/5bc59bada817e.jpg
xiaoymin
2018-10-16 17:24:34 +08:00
@gam2046 你这个版本有点老了。今天刚发布了新版,最新版 1.8.5,试试吧~~
xiaoymin
2018-10-16 17:25:56 +08:00
gam2046
2018-10-16 17:38:44 +08:00
新的尝试了,十分好。

https://github.com/xiaoymin/Swagger-Bootstrap-UI/blob/master/README.md#L92

你这写的 1.6。所以,我以为这就是最新的了。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/493395

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX