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

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

爱意满满的作品展示区。

这是一个创建于 2283 天前的主题，其中的信息可能已经有所发展或是发生改变。

简介

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

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

主要功能：

生成 markdown 格式的离线文档
可自定义全局参数
左右多 tab 组合
请求参数、响应示例 treetable 组件展示,方便展示

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

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

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

两大核心功能

接口文档说明,效果图如下：

在线调试功能,效果图如下:

swagger

文档

替换

效果

24 条回复 • 2019-12-16 17:12:34 +08:00

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

https://github.com/darosh/angular-swagger-ui-material

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 via iPhone

@youngxhui 集成还是继承？

youngxhui

2018-09-29 10:28:50 +08:00 via Android

@wangcansun 不好意思打错字了是集成😁

wangcansun

2018-09-29 10:36:25 +08:00 via iPhone

@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

185 的新闻链接： https://www.oschina.net/news/100888/swagger-bootstrap-ui-1-8-5-released

gam2046

2018-10-16 17:38:44 +08:00

新的尝试了，十分好。

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

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

xiaoymin

2018-10-17 09:08:52 +08:00

@gam2046 ok，以后升级了把这个 README 也改改：）

xiaoymin

2018-10-31 14:54:16 +08:00

xiaoymin

2018-11-12 11:31:55 +08:00

xiaoymin

2019-12-16 17:12:34 +08:00

2.0 版本

https://www.oschina.net/news/112095/knife4j-2-0-released