强悍！Apifox的API接口文档功能

在当前主流的前端后端分离模式开发下，拥有一个API接口文档并且是简洁的接口文档是很有必要的一个东西。Apifox的API接口文档是我遇到过最贴心程序员的一个接口文档了，他不止解决了我遇到的开发痛点，而且这个接口文档功能十分强悍，卷起来吧！

 

如今众多的API接口文档工具层出不穷，swagger、yapi、Knife4j等等。但是他们都多多少少都有些许弊端。比如我们后端的同学最经常使用的的swagger-ui，但是它都有着以下的痛点:

提交参数为JSON没法格式化，参数错了查找麻烦，返回结果没法折叠，太长了没法看

swagger-ui 在接口数量变多的时候非常难用，连分类菜单都没有

 

而在最近的技术社区里我发现了Apifox这个API接口工具。它是相当于一个集成了Postman + Swagger + Mock + JMeter的一个工具，不仅免费而且接口文档功能十分强悍。

1.1 如何生成一个在线的API接口文档

1.1.1 第一步

先到Apifox的官网下载一个Apifox客户端。当然啦，直接使用web版也不妨碍我们后续的操作步骤。

 

打开客户端或者web端进行登录，注册一个新账号。

2.1.2 第二步

更好演示，现在模拟一个jeetcg-Boot的前后端分离的开源项目。这个项目拥有一个自定义的的接口文档，可以导出一些OpenApi、Markdown格式的文档，那就可以使用导出来的接口文档去做演示看如何对接到Apifox提供的在线文档。

 

如果当前同学是没有类似swagger格式的文档的话也没关系，因为Apifox支持21种格式的导入方式。

把jeetcg-boot项目的接口文档导出一个OpenApi.json的文件，通过Apifox的导入功能把我当前项目的接口给转到了Apifox上面

 

 

简单的步骤，成功的移植到了Apifox上面进行管理了。

这里要称赞一下Apifox设计的确实很好看，排版也舒服，对于我这种颜值控来说😄😄😄。

2.1.3 第三步

通过左侧的 在线分享 点击一下我们的新建分享

 

填好信息，点击保存生成一个我们项目的在线接口文档url。复制当前生成的在线接口文档链接，打开就是我们的项目接口文档。

 

 

 

2.2 Apifox的在线接口文档有什么“魔法”（优势）

2.2.1 直接在文档运行接口

细心的同学肯定发现了在选择一条接口后文档右侧有一个运行的按钮，点击该按钮，就显示出一个执行的操作界面，点击发送之后我们可以看到返回的结果正是如同我们接口的返回响应的格式一样。而调用的正是我们选择生成该接口时候用的云端mock环境，所以现在展示的数据是由mock给我们生成的假数据。

而mock环境下调用的接口也方便前端程序员先行对后端进行开发，并不会被后端的同学们给卡着进度。

 

2.2.2 生成13种语言的请求示例代码

在文档的中间部分一些编程语言的图标。他们都是干什么用的呢??

 

身为前端程序员的我，自然而然地就用javascript来给同学们介绍一下了。点开javascript图标我们发现下面有一行tab提供选择，相信文章前也是前端程序员的同学们也不陌生，这些正是js常见的请求方法而选择每个方法的tab下面的编辑器就会有使用该方法调用当前接口的代码。第一次看到这个功能的时候我是惊呆了，还有这种那么贴心的交互？？🙀🙀🙀🙀

2.2.3 生成模型代码

生成的模型代码主要是对返回的相应参数生成的模型代码。

 

需要生成什么类型的模型代码，取决于同学们的需要，去进行配置。

三、Apifox在线分享接口文档的细节之处

Apifox接口文档是真处处为了程序员效率和使用便捷着想。

3.1.1 接口连接可直接点击复制：

 

3.1.2 文档的整体布局

文档的整体布局呈左右结构，那么我们程序员在阅读该文档的时候需要做测试运行的时候就可以左右对照参数去排查是否有参数不符合要求的情况，就不同与swagger参数在上请求在下，需要上下移动，便利性就大大的降低了。

3.1.3 在运行的时候批量编辑参数

在运行操作界面里我们有时侯有大量的请求参数可能需要临时变动去厕所一下，测试如果一个个在表格去改也是比较痛苦的一件事情，而Apifox提供了一种批量编辑的交互让开发者们更便捷的达到他们的目的

 

使用过Apifox我相信都会被这个软件的细节之处，API接口文档功能强大之处给留下深刻的印象！一个软件工具的使命肯定是要为了使用者的便捷着想，处处的简化使用者的操作让工作更效率，这种才是一种好的工具的表现。

官网体验：https://www.apifox.cn/