分享一个自己重写 swagger 的 ui 工具 swagger-bootstrap-ui - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
xiaoymin
V2EX    分享创造

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

  •  
  •   xiaoymin 2018-09-28 09:03:34 +08:00 10235 次点击
    这是一个创建于 2585 天前的主题,其中的信息可能已经有所发展或是发生改变。

    简介

    swagger-bootstrap-uiSwagger的前端 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

    两大核心功能

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

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

    24 条回复    2019-12-16 17:12:34 +08:00
    thisisgpy
        1
    thisisgpy  
       2018-09-28 13:51:52 +08:00   1
    已在公司推广使用,很不错。
    xiaoymin
        2
    xiaoymin  
    OP
       2018-09-28 15:19:21 +08:00
    @thisisgpy 欢迎反馈意见~~~~
    wangcansun
        3
    wangcansun  
       2018-09-28 15:59:15 +08:00
    赞赞赞
    wangcansun
        4
    wangcansun  
       2018-09-28 15:59:38 +08:00
    我之前使用的是 material 的 swagger ui
    wangcansun
        5
    wangcansun  
       2018-09-28 16:00:44 +08:00
    run27017
        6
    run27017  
       2018-09-28 16:21:19 +08:00
    顺便推广一下我的一个在线 Swagger Doc 编辑网站:

    > https://run27.top/swaggerhuge

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

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

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

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

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

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

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

    你这写的 1.6。所以,我以为这就是最新的了。
    xiaoymin
        21
    xiaoymin  
    OP
       2018-10-17 09:08:52 +08:00
    @gam2046 ok,以后升级了把这个 README 也改改:)
    xiaoymin
        22
    xiaoymin  
    OP
       2018-10-31 14:54:16 +08:00
    xiaoymin
        23
    xiaoymin  
    OP
       2018-11-12 11:31:55 +08:00
    xiaoymin
        24
    xiaoymin  
    OP
       2019-12-16 17:12:34 +08:00
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     2506 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 26ms UTC 06:59 PVG 14:59 LAX 23:59 JFK 02:59
    Do have faith in what you're doing.
    ubao msn snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86