除了 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 上找到项目，安装插件，体验一下~

 

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

Github ：

https://github.com/Postcatlab/postcat

了解 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 安全等高达29 款插件

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

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