Postcat 是一个强大的开源、跨平台(Windows、Mac、Linux、Browsers...)的 API 开发测试工具,支持 REST、Websocket 等协议(即将支持 GraphQL、gRPC、TCP、UDP),帮助你加速完成 API 开发和测试工作。
作为代码的下游 API 文档工具,解决痛点的同时融合 Swagger 生态。
Postcat 通过以下两种方式支持代码生成文档:
-
如果你之前使用 Swagger,我们支持从 Swagger Url 自动同步 Swagger 数据;
-
Jebrains IDE 插件,安装后可以在 IDE 中右键一键同步代码注释中的 API 文档信息到 Postcat。(下一篇内容会讲到)
下面即为大家演示如何如何支持 Swagger Url 自动同步 Swagger 数据
从 Swagger URL 生成文档
提示:要使用这个功能,一定得安装 Swagger URL 插件才行
首先,找到对应插件,并安装
选择通过 URL 导入同步 API
填写 Swagger URL 地址:
导入成功,右侧展示了新增的 API
在 Postcat 上只要通过安装这个导入插件,再也不用担心 Swagger 的数据无法同步过来了。
这个项目是开源的,如果你觉得这个项目还不错的话,不妨点个 Star 支持一下!
Github :
https://github.com/Postcatlab/postcat