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

Posted 程序员 二黑

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Apifox:成熟的测试工具要学会自己写接口文档相关的知识,希望对你有一定的参考价值。

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

今天发现了一个非常好用的接口测试工具Apifox,相比于Postman,他还拥有一个非常nb的功能,在接口的测试完成后,它可以一键生成接口文档

下载地址(免费哟):https://www.apifox.cn/

进入页面

1.Apifox接口测试功能

我们来到新建页面,新建一个快捷请求


使用步骤如下:




随后点击"发送",我们可以在下方看见接口的返回值


各式各样,应有尽有


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

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

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

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

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

总之,写接口文档是一件非常麻烦的事,于是,我们尝试去使用Apifox的”一键生成接口“功能

2.Apifox一键生成接口文档

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



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


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



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

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

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

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

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

(Mock,接口自动化测试)

详见Apifox官方文档


资源分享

下面这份资源,对于想学习【软件测试】的朋友来说应该是最全面最完整的备战仓库,希望也能帮助到你!

以上是关于Apifox:成熟的测试工具要学会自己写接口文档的主要内容,如果未能解决你的问题,请参考以下文章

如何使用 Apifox 来管理测试你的接口

Apifox写接口自动化测试用例总结-1

效率神器Apifox_API 文档API 调试API MockAPI 自动化测试工具推荐

用了国产接口管理神器 Apifox 之后,我果断从 Postman “脱坑”了

后端适用,Apifox接口文档设计和调试教程工具篇

Apifox怎么导出jmeter文档