关于swagger:除了-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