除了 Swagger，这个开源 API 工具生成文档更高效！

提起 Swagger，经常接触接口开发的朋友，一定知道并且都熟练使用了。

Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务。

我们不难看出 Swagger 有以下 3 个重要的作用：

1. 将项目中所有的接口展现在页面上，这样后端程序员就不需要专门为前端使用者编写专门的接口文档；
2. 当接口更新之后，只需要修改代码中的 Swagger 描述就可以实时生成新的接口文档了，从而规避了接口文档老旧不能使用的问题；
3. 通过 Swagger 页面，我们可以直接进行接口调用，降低了项目开发阶段的调试成本。

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

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

但我这次强烈推荐的工具是能完美解决 Swagger 痛点的开源 API 管理工具，Postcat(如今在github上也有 3.4 k star)

作为代码的下游 API 文档工具，Postcat 解决痛点的同时融合 Swagger 生态。

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

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

登录 Postcat 官网或者去 github 上找到项目，安装插件，体验一下~

选择通过 URL 导入同步 API

填写 Swagger URL 地址：

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

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

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

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