爱意满满的作品展示区。
xiaoymin

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

  •  
  •   xiaoymin · Sep 28, 2018 · 10588 views
    This topic created in 2786 days ago, the information mentioned may be changed or developed.

    简介

    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 replies    2019-12-16 17:12:34 +08:00
    thisisgpy
        1
    thisisgpy  
       Sep 28, 2018   ❤️ 1
    已在公司推广使用,很不错。
    xiaoymin
        2
    xiaoymin  
    OP
       Sep 28, 2018
    @thisisgpy 欢迎反馈意见~~~~
    wangcansun
        3
    wangcansun  
       Sep 28, 2018
    赞赞赞
    wangcansun
        4
    wangcansun  
       Sep 28, 2018
    我之前使用的是 material 的 swagger ui
    run27017
        6
    run27017  
       Sep 28, 2018
    顺便推广一下我的一个在线 Swagger Doc 编辑网站:

    > https://run27.top/swaggerhuge

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

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

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

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

    其它语言暂时还没完善
    xtaxcy
        15
    xtaxcy  
       Oct 4, 2018
    赞。适用一下。
    wzw
        16
    wzw  
       Oct 11, 2018
    @run27017 #6 可以一键测试吗
    ntdll
        17
    ntdll  
       Oct 16, 2018
    真的很不错。不过可以对于页面宽度不足的情况下,调整一下布局嘛。

    https://i.loli.net/2018/10/16/5bc59bada817e.jpg
    xiaoymin
        18
    xiaoymin  
    OP
       Oct 16, 2018
    @gam2046 你这个版本有点老了。今天刚发布了新版,最新版 1.8.5,试试吧~~
    xiaoymin
        19
    xiaoymin  
    OP
       Oct 16, 2018
    ntdll
        20
    ntdll  
       Oct 16, 2018
    新的尝试了,十分好。

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

    你这写的 1.6。所以,我以为这就是最新的了。
    xiaoymin
        21
    xiaoymin  
    OP
       Oct 17, 2018
    @gam2046 ok,以后升级了把这个 README 也改改:)
    xiaoymin
        22
    xiaoymin  
    OP
       Oct 31, 2018
    xiaoymin
        23
    xiaoymin  
    OP
       Nov 12, 2018
    xiaoymin
        24
    xiaoymin  
    OP
       Dec 16, 2019
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   2935 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 80ms · UTC 14:19 · PVG 22:19 · LAX 07:19 · JFK 10:19
    ♥ Do have faith in what you're doing.