【Apifox】测试工具自动编写接口文档

在开发过程中,我们总是避免不了进行接口的测试,

而相比手动敲测试代码,使用测试工具进行测试更为便捷,高效

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

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

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

下载地址(免费哟):

Apifox - API 文档、调试、Mock、测试一体化协作平台 - 接口文档工具,接口自动化测试工具,接口Mock工具,API文档工具,API Mock工具,API自动化测试工具

进入页面

1.Apifox接口测试功能

我们来到新建页面

新建一个快捷请求

使用步骤如下:

随后点击"发送"

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

各式各样,应有尽有

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

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

xx接口,xx字段,xxx参数,输入样例:xxx,返回样例:xxx

(为了让其它接口使用者能够更清晰明了使用你写的接口)

(其实是为了不被喷。。。"rnm,sb开发者,又不写文档")

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

于是,我们尝试去使用Apifox的"一键生成接口"功能

2.Apifox一键生成接口文档

完成接口测试后,我们选择"保存"==>"保存为接口"

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

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

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

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

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

(应该以后会更新这个功能吧,期待,但md格式也够用)

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

(Mock,接口自动化测试)

详见Apifox官方文档:

最后感谢每一个认真阅读我文章的人,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走:

这些资料,对于【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴上万个测试工程师们走过最艰难的路程,希望也能帮助到你!

相关推荐
立志成为大牛的小牛1 天前
数据结构——五十四、处理冲突的方法——开放定址法(王道408)
数据结构·学习·程序人生·考研·算法
小白程序员成长日记1 天前
2025.12.03 力扣每日一题
算法·leetcode·职场和发展
我的xiaodoujiao1 天前
使用 Python 语言 从 0 到 1 搭建完整 Web UI自动化测试学习系列 31--开源电商商城系统项目实战--加入购物车、提交订单测试场景
python·学习·测试工具·pytest
Molesidy1 天前
【Embedded Development】嵌入式面试问题汇总(仅供参考)
面试·职场和发展
吃着火锅x唱着歌1 天前
LeetCode 3583.统计特殊三元组
算法·leetcode·职场和发展
测试人社区—52721 天前
你的单元测试真的“单元”吗?
前端·人工智能·git·测试工具·单元测试·自动化·log4j
小南家的青蛙1 天前
LeetCode第773题 - 滑动谜题
算法·leetcode·职场和发展
野蛮人6号1 天前
力扣热题100道之78子集
算法·leetcode·职场和发展
郝学胜-神的一滴1 天前
Python的内置类型:深入理解与使用指南
开发语言·python·程序人生
测试人社区—52721 天前
破茧成蝶:DevOps流水线测试环节的效能跃迁之路
运维·前端·人工智能·git·测试工具·自动化·devops