乐趣区

关于后端:Postcat-如何生成接口文档2-分钟学会

Postcat 是一个弱小的开源、跨平台(Windows、Mac、Linux、Browsers…)的 API 开发测试工具,反对 REST、Websocket 等协定(行将反对 GraphQL、gRPC、TCP、UDP),帮忙你减速实现 API 开发和测试工作。

作为代码的上游 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 的数据无奈同步过去了。

如果喜爱,无妨 Star 反对一下这个我的项目是开源的,如果你感觉这个我的项目还不错的话,无妨点个 Star 反对一下!

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

退出移动版