前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Swagger URL 插件上线!同步文档更便捷!

Swagger URL 插件上线!同步文档更便捷!

原创
作者头像
前端菜鸡2号
发布2023-03-17 16:49:49
4990
发布2023-03-17 16:49:49
举报
文章被收录于专栏:开源开源

本次版本更新主要围绕这几个方面:

  • 从 Swagger URL 同步 API
  • API 编辑页面自动调整编辑器高度
  • Windows 安装包自定义 UI

但我最想说的还是这个 【从Swagger URL 同步 API】 的部分,也是本次更新的重点。

对于中小型(特别是 Java 技术栈)的开发团队来说,Swagger 是一个便捷的选择,好处是:

  • 代码即文档,编写成本低,不存在同步不及时的问题;
  • 生态好,各大 API 平台都支持基于 OpenAPI 格式的拓展。

但使用 Swagger 的用户有以下几个痛点:

  • 测试不方便,有简单的调用测试,但是没有历史也没有鉴权等功能;
  • 没有人员管理,无法协作/通知/版本管理;
  • 对于前端人员不友好,没有参数描述/值可能性,没有 Mock ;
  • 对代码有侵入性。

我们不追求让大家强制切换工具,而是作为代码的下游 API 文档工具,解决痛点的同时融合 Swagger 生态。

Postcat 通过以下两种方式支持代码生成文档:

  1. 如果你之前使用 Swagger,我们支持从 Swagger Url 自动同步 Swagger 数据;
  2. Jebrains IDE 插件,安装后可以在 IDE 中右键一键同步代码注释中的 API 文档信息到 Postcat。(下一篇内容会讲到)

下面即为大家演示如何如何支持 Swagger Url 自动同步 Swagger 数据

从 Swagger URL 生成文档

提示:要使用这个功能,一定得安装 Swagger URL 插件才行

首先,找到对应插件,并安装

选择通过 URL 导入同步 API

填写 Swagger URL 地址:

导入成功,右侧展示了新增的 API

在 Postcat 上只要通过安装这个导入插件,再也不用担心 Swagger 的数据无法同步过来了。

了解 Postcat:

Postcat 是一个强大的开源、跨平台(Windows、Mac、Linux、Browsers...)的 API 开发测试工具,支持 REST、Websocket 等协议(即将支持 GraphQL、gRPC、TCP、UDP),帮助你加速完成 API 开发和测试工作。

Postcat 核心功能:

  1. API 文档管理:可视化 API 设计,生成 API 文档
  2. API 测试:自动生成测试参数,自动生成测试用例,可视化数据编辑
  3. 插件拓展:众多插件扩展产品功能,打造属于你和团队的 API 开发平台
  4. Mock:根据文档自动生成Mock,或创建自定义 Mock 满足复杂场景
  5. 团队协作:既能实现API 分享也能可以创建云空间共同协作

Postcat 优势:

  1. 免登录即可测试:省去繁琐的验证登录的操作
  2. 界面简洁:没有冗余的功能与复杂选项
  3. 免费:中小团队以及个人使用
  4. 丰富的插件:支持数据迁移、主题、API 安全等高达22款插件
  5. 国产:能更好的理解国内用户的需求,与开发团队沟通无障碍
  6. 完善的用户文档:跟着操作就能快速上手

多提 Issue !多反馈!

在使用过程中有任何疑问,可以在线提 Issue(强烈推荐这种开源的方式),提问题本身就已经在贡献社区了:

https://github.com/Postcatlab/postcat/issues

如果喜欢,不妨Star 支持一下

这个项目是开源的,如果你觉得这个项目还不错的话,不妨点个 Star 支持一下!

Github :

https://github.com/Postcatlab/postcat

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 从 Swagger URL 生成文档
    • 了解 Postcat:
      • Postcat 核心功能:
        • Postcat 优势:
          • 多提 Issue !多反馈!
            • 如果喜欢,不妨Star 支持一下
            相关产品与服务
            Prowork 团队协同
            ProWork 团队协同(以下简称 ProWork )是便捷高效的协同平台,为团队中的不同角色提供支持。团队成员可以通过日历、清单来规划每⽇的工作,同时管理者也可以通过统计报表随时掌握团队状况。ProWork 摒弃了僵化的流程,通过灵活轻量的任务管理体系,满足不同团队的实际情况,目前 ProWork 所有功能均可免费使用。
            领券
            问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档