接口文档管理神器 Apifox，我爱了

今天这篇文章主要想介绍一下开发接口文档，一个好的接口文档对于前后端开发效率的成本可以减少。
在我现在和前面的公司，有的直接发txt记事本文档，有的使用 SwaggerUI,还有就是 ShowDow API文档,这些文档都不能提高效率。下面我们看一下SwaggerUi 和 ShowDow 工具是怎么样的。

Swagger UI 自动生成的接口文档，如下所示：

使用 Swagger UI 文档的不好之处：

• 查看多级模型时要一级级点开
• 在接口数量变多的时候非常难用，连分类菜单都没有
• 提交参数为 JSON 的时候不能格式化
• 参数出错的时候查找麻烦
• 返回结果不能折叠，长得没法看

使用 Swagger UI 确实成本会很高，而且不容易调试和查找问题。

而使用 ShowDow 就很好的解决了 Swagger UI 文档一些不足之处，如下：

从上图我们知道，ShowDow 只是记录了一个接口需要的参数、路径等等，但是能不能调试呢，显然 ShowDow 做不到。

那么有没有功能更加强大的在线接口文档工具，直接在线就把接口调了呢，那么这个接口文档工具应该具备哪些功能，应该具备如下的功能：

• 调试功能：前端能很方便地调试接口数据
• 代码生成功能：这样前端可以少写点代码，提高效率同时也提高了准确性
• 接口同步功能：接口文档一定要是最新的代码信息

下面接下来就是重点的要说的一个牛逼的 API 接口文档，为什么说它牛逼呢？因为它满身都是牛逼到不行的特性，比平常见到那些 API 文档不知道要好到哪里去。

API接口文档地址：https://www.apifox.cn/
操作文档：https://www.apifox.cn/help/app/code-generator/

在线调试

这个文档是用 Apifox 做的，完全免费不限功能，点击文档右上角的运行按钮，就会出现“在线运行”的模块

在这个界面上就能直接调试接口了，步骤：
填参数、选环境、点发送，接口请求就发出去了。下面就有返回结果，根本用不着 Postman，更不用把 API 照着抄一遍。

自动生成

当我们前面开发使用的是 Swagger UI ，现在上线时间紧，没有时间去搞这个接口文档呢，配置起来应该很麻烦吧？其实 Apifox 想到了，帮我们实现获取 SwaggerUi 接口的功能，只要把 Swagger 的 URL 填到 Apifox 里面去，Apifox 就会自动导入 API 定义，然后就能生成这个好用的文档，如下：

而且，还可以导入多个来源的 Swagger UI，一套接口文档来自多个不同的后端项目也没问题。

生成请求代码

Apifox 神奇的地方还有自动生成代码，点击对应的语言，就能直接生成请求的代码，左边还可以选择你生成代码的配置，包括：编程语言、命名风格、校验开启等等。

这里 Java，C，C++，JS，Swift，Go，Python，TypeScript……基本上我知道的语言全都有，个人感觉自己写的 Java 代码还没它自动生成写的好。

云端 Mock

云端 Mock，就是在 API 文档页面上就直接实现 Mock 服务，虚拟一个服务端出来。

比如，我们要请求一个银行的 API，银行肯定不会让你随便请求啊，都是要验证身份限制次数的。用这个 Apifox 呢，你就可以直接在接口文档上请求 Mock 数据了，也不会限制你的次数，也不会收你的钱。

以下是测试环境、正式环境和云端 Mock 环境，只要切换到云端 Mock 环境，请求就会发送给 Mock 服务器，跟正式环境调试一样。

用浏览器打开这个 URL（https://mock.apifox.cn/m1/1035644-0-default/users/2）直接访问 URL 就能获取到 Mock 数据了，是不是感觉很爽。

API Hub

在 Apifox 里面，已经把这些最常用的第三方 API 都做好了，即时通讯的，电商的，查快递的，项目管理的，统统都有。每一个都可以在线运行、生成代码，也可以克隆到自己的项目里，然后用云端 Mock。

如果大家公司有接口要公开出去的话，也可以发布到这个 API Hub。

总结

Apifox = Postman + Swagger + Mock + JMeter。集接口文档工具、接口 Mock 工具、接口自动化测试工具、接口调试工具于一体，提升 10 倍研发效率。

Apifox 中还很多的特性没有讲，如果大家想要使用可以去学习学习，上面已经把地址和操作文档都贴出来了，这款 API 接口文档真的很强大，只要你熟悉，用起来会很爽。