乐趣区

关于postman:Swagger-URL-插件上线同步生成文档更简单

jiezi

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

  • 从 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

退出移动版