V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
xiaoymin
V2EX  ›  分享创造

基于 Chrome 扩展程序的 Swagger 资源渲染程序

  •  
  •   xiaoymin · 2019-05-20 10:52:42 +08:00 · 2951 次点击
    这是一个创建于 2021 天前的主题,其中的信息可能已经有所发展或是发生改变。

    随着 swagger-bootstrap-ui 已经历时两年多,发布了 26 个版本,目前也得到的很多 Java 开发者的青睐,如果你是使用 Swagger 来构建你的文档服务,那么,swagger-bootstrap-ui 你一定不容错过

    正因为如此,在 Java 领域已经非常方便的集成到项目中了,但因为 Swagger 本身是规范框架,所以只要是支持 Swagger 的语言,都应该能使用 swagger-bootstrap-ui 这款渲染 ui 程序,但是由于时间原因,我一直没有将静态文件,核心渲染 JS 剥离出来,虽然前段时间剥离了一版前端版本 swagger-bootstrap-ui-front,但是还是很难用

    所以,基于 Chrome 浏览器的扩展程序 swagger-bootstrap-ui-extension 诞生了

    swagger-bootstrap-ui-extension 可以在 chrome 浏览器的扩展程序中添加,开发人员可以根据 Swagger 的 JSON 文件、或者 Swagger 资源接口 url 来使用 swagger-bootstrap-ui 的渲染 Ui 程序,同时也可以进行调试.这大大提升了使用 Swagger 的开发体验.

    先来看效果图:

    功能说明 目前 sbue 扩展程序是基于 swagger-bootstrap-ui 最新版本 1.9.3 基础上进行集成开发.程序稳定性已经得到了时间的验证.

    主要包括功能如下:

    • JSON:提供根据输入的 Swagger 标准 JSON 文件进行 ui 渲染

    • RESTful API:提供根据请求 Swagger 资源接口的方式进行 UI 渲染

    • 源码:sbue 的 Gitee 源码包地址

    • 文档:sbue 的相关文档介绍说明

    • 清理缓存:清理 sbue 产生的缓存

    • 选项:sbue 的相关选项配置,个性化信息

    功能效果图菜单:

    目前主要功能:

    • 基于 Swagger 的标准 JSON 文件来渲染 Swagger 接口资源

    • 基于 Swagger 资源接口返回的 JSON 来渲染 Swagger 文档

    • 接口代理配置,可以进行接口调试.

    下载

    可以在 chrome 的应用商店进行下载体验

    源码

    GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui

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

    Git 目录下的子文件夹:swagger-bootstrap-ui-extension

    2 条回复    2019-05-21 09:20:48 +08:00
    wen704
        1
    wen704  
       2019-05-20 11:37:09 +08:00
    看了一下很强,要是能支持 yaml 就更强了,这个 ui 风格就很适合快速定位 api,很方便,
    xiaoymin
        2
    xiaoymin  
    OP
       2019-05-21 09:20:48 +08:00
    @wen704 现在还是 1.0 版本,后面会把更多有趣的功能实现掉
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2838 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 22ms · UTC 09:07 · PVG 17:07 · LAX 01:07 · JFK 04:07
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.