Apifox：成熟的测试工具要学会自己写接口文档

蔚落 2023-10-07 23:08 23阅读 0赞

## Apifox：成熟的测试工具要学会自己写接口文档 ##

## **目录**：导读 ##

1.Apifox接口测试功能

2.Apifox一键生成接口文档

--------------------

![048f46e2a0de429daf544466bed47dbf.png][]

> **在开发过程中，我们总是避免不了进行接口的测试，**
> 
> **而相比手动敲测试代码，使用测试工具进行测试更为便捷，高效**

**今天发现了一个非常好用的接口测试工具Apifox**

**相比于Postman，他还拥有一个非常nb的功能，**

**在接口的测试完成后，它可以一键生成接口文档**

**下载地址（免费哟）：**

**[Apifox - API 文档、调试、Mock、测试一体化协作平台 - 接口文档工具，接口自动化测试工具，接口Mock工具，API文档工具，API Mock工具，API自动化测试工具][Apifox - API _Mock_ - _Mock_API_API Mock_API]**

**进入页面**

![1ee15cba18640377f83f05589a79e9fa.png][]

**（****非常的清爽，好看）**

## 1.Apifox接口测试功能 ##

**我们来到新建页面**

**新建一个快捷请求**

![c5ebc805e6a378cc16905d8e3f9d776e.png][]

**使用步骤如下：**

![bb4409b3f7be48a9957ed054e106ef01.png][]

![d70556cb5d43110bcb4defa14eb28948.png][]

![24dd51891e3514b7c9a8faeeade7109b.png][]

**随后点击"发送"**

**我们可以在下方看见接口的返回值**

![5d585c448c32cbdf793d8de88b7a9c61.png][]

**各式各样，应有尽有**

![91418ae0b17af4636dd1a0c83507c0f2.gif][]

**接口测试的部分了到这里为止**

**然后，你要专门找时间，再用某个工具，写一份接口文档**

**xx接口，xx字段，xxx参数，输入样例：xxx，返回样例：xxx**

**（为了让其它接口使用者能够更清晰明了使用你写的接口）**

**（其实是为了不被喷。。。”rnm,sb开发者，又不写文档“）**

**总之，写接口文档是一件非常麻烦的事**

**于是，我们尝试去使用Apifox的”一键生成接口“功能**

## 2.Apifox一键生成接口文档 ##

**完成接口测试后，我们选择“保存”==>"保存为接口"**

![82b5e370189fb50f05ecd568abc0ae58.png][]

![939a067a4e845377f020edf8519278bc.png][]

**非常漂亮的一份接口文档,如下：**

![93d6c43e1553db10cbd0ec615d28787c.gif][]

**当然，我们还可以将文档进行导出**

![7578481e27b43b399f5cd3538ce52856.png][]

![4054fa87e5f7b65916f00af129ac5208.png][]

**暂时还不能直接导出Word、PDF格式，**

**（虽然那里有这个按钮了，但其实并不能导出，暂时不支持，我愿称之为饼）**

**(你可以把.md格式转成word对不对)**

**（应该以后会更新这个功能吧，期待，但md格式也够用）**

**当然还用很多看上去很吊但我暂时不会用的功能**

**（Mock，接口自动化测试）**

**详见Apifox官方文档：**

**[动态变量 / 随机参数 | Apifox 使用文档][_ _ _ Apifox]**

> **写在最后**
> 
> 如果你觉得文章还不错，请大家 **点赞、分享、留言** 下，因为这将是我持续输出更多优质文章的最强动力！
> 
> 看到这篇文章的人有觉得我的理解有误的地方，也欢迎评论和探讨～

[048f46e2a0de429daf544466bed47dbf.png]: https://img-blog.csdnimg.cn/048f46e2a0de429daf544466bed47dbf.png
[Apifox - API _Mock_ - _Mock_API_API Mock_API]: https://www.apifox.cn/
[1ee15cba18640377f83f05589a79e9fa.png]: https://img-blog.csdnimg.cn/img_convert/1ee15cba18640377f83f05589a79e9fa.png
[c5ebc805e6a378cc16905d8e3f9d776e.png]: https://img-blog.csdnimg.cn/img_convert/c5ebc805e6a378cc16905d8e3f9d776e.png
[bb4409b3f7be48a9957ed054e106ef01.png]: https://img-blog.csdnimg.cn/img_convert/bb4409b3f7be48a9957ed054e106ef01.png
[d70556cb5d43110bcb4defa14eb28948.png]: https://img-blog.csdnimg.cn/img_convert/d70556cb5d43110bcb4defa14eb28948.png
[24dd51891e3514b7c9a8faeeade7109b.png]: https://img-blog.csdnimg.cn/img_convert/24dd51891e3514b7c9a8faeeade7109b.png
[5d585c448c32cbdf793d8de88b7a9c61.png]: https://img-blog.csdnimg.cn/img_convert/5d585c448c32cbdf793d8de88b7a9c61.png
[91418ae0b17af4636dd1a0c83507c0f2.gif]: https://img-blog.csdnimg.cn/img_convert/91418ae0b17af4636dd1a0c83507c0f2.gif
[82b5e370189fb50f05ecd568abc0ae58.png]: https://img-blog.csdnimg.cn/img_convert/82b5e370189fb50f05ecd568abc0ae58.png
[939a067a4e845377f020edf8519278bc.png]: https://img-blog.csdnimg.cn/img_convert/939a067a4e845377f020edf8519278bc.png
[93d6c43e1553db10cbd0ec615d28787c.gif]: https://img-blog.csdnimg.cn/img_convert/93d6c43e1553db10cbd0ec615d28787c.gif
[7578481e27b43b399f5cd3538ce52856.png]: https://img-blog.csdnimg.cn/img_convert/7578481e27b43b399f5cd3538ce52856.png
[4054fa87e5f7b65916f00af129ac5208.png]: https://img-blog.csdnimg.cn/img_convert/4054fa87e5f7b65916f00af129ac5208.png
[_ _ _ Apifox]: https://www.apifox.cn/help/app/api-manage/dynamic-variables/