Swagger URL 插件上线,同步文档很简单

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

  • 从 Swagger URL 同步 API

  • API 编辑页面自动调整编辑器高度

  • Windows 安装包自定义 UI

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

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

  • 代码即文档,编写成本低,不存在同步不及时的问题;

  • 生态好,各大 API 平台都支持基于 OpenAPI 格式的拓展。

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

  • 测试不方便,有简单的调用测试,但是没有历史也没有鉴权等功能;

  • 没有人员管理,无法协作/通知/版本管理;

  • 对于前端人员不友好,没有参数描述/值可能性,没有 Mock ;

  • 对代码有侵入性。

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

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

  1. 如果你之前使用 Swagger,我们支持从 Swagger Url 自动同步 Swagger 数据;

  1. 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 文档

  1. API 测试:自动生成测试参数,自动生成测试用例,可视化数据编辑

  1. 插件拓展:众多插件扩展产品功能,打造属于你和团队的 API 开发平台

  1. Mock:根据文档自动生成Mock,或创建自定义 Mock 满足复杂场景

  1. 团队协作:既能实现API 分享也能可以创建云空间共同协作

Postcat 优势:

  1. 免登录即可测试:省去繁琐的验证登录的操作

  1. 界面简洁:没有冗余的功能与复杂选项

  1. 免费:中小团队以及个人使用

  1. 丰富的插件:支持数据迁移、主题、API 安全等高达22款插件

  1. 国产:能更好的理解国内用户的需求,与开发团队沟通无障碍

  1. 完善的用户文档:跟着操作就能快速上手

多提 Issue !多反馈!

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

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

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

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

Github :

https://github.com/Postcatlab/postcat

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值