【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官方文档:

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

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

相关推荐
John_ToDebug14 分钟前
在代码的黄昏,建筑师诞生:从打字员到AI协作设计者的范式革命
人工智能·程序人生
拾光师43 分钟前
CentOS 7 老树开新花:从零部署 Dify 全栈应用(含 Go/Rust/GCC 升级避坑)
程序人生
Wpa.wk1 小时前
接口自动化 - 多环境统一文件配置 +多响应统一转换处理
运维·服务器·测试工具·自动化·接口自动化·统一配置
DolitD1 小时前
云流技术深度剖析:国内云渲染主流技术与开源和海外厂商技术实测对比
功能测试·云原生·开源·云计算·实时云渲染
2501_901147831 小时前
面试必看:优势洗牌
笔记·学习·算法·面试·职场和发展
网安墨雨2 小时前
Python自动化一------pytes与allure结合生成测试报告
开发语言·自动化测试·软件测试·python·职场和发展·自动化
@zulnger2 小时前
selenium 自动化测试工具实战项目(窗口切换)
selenium·测试工具·自动化
铉铉这波能秀2 小时前
LeetCode Hot100 中 enumerate 函数的妙用(2026.2月版)
数据结构·python·算法·leetcode·职场和发展·开发
南极星10052 小时前
我的创作纪念日--128天
java·python·opencv·职场和发展
觉醒大王14 小时前
AI写的青基中了
人工智能·笔记·深度学习·学习·职场和发展·学习方法