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

apifox,成熟,测试工具,学会,自己,接口,文档 · 浏览次数 : 413

小编点评

**Apifox 接口测试工具介绍** **优势:** - 一键生成接口文档,方便开发人员生成接口文档。 - 自动化接口测试,提高测试效率。 - 提供 API 文档、调试和 Mock 功能。 - 提供免费的 API 文档下载地址。 **步骤:** 1. 新建页面新建一个快捷请求。 2. 使用步骤 above 发送接口请求。 3. 在下方看见接口的返回值。 4. 写一份接口文档,包含接口名称、请求方法、参数、请求样例和响应样例。 5. 选择“保存”并选择“保存为接口”。 6. 可以将文档导出为 .md 或 .word 文件。 **其他功能:** - Mock 和 API 自动化测试。 - 动态变量和随机参数支持。 **使用说明:** - 获取 Apifox 的 API 文档:动态变量 / 随机参数 | Apifox 使用文档 - 启动 Apifox。 - 在 API 文档页面中创建新接口。 - 使用步骤 2 发送接口请求。 - 在下方页面中查看返回值。 - 写文档并选择“保存为接口”。

正文

好家伙,

 

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

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

 

今天发现了一个非常好用的接口测试工具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官方文档:

动态变量 / 随机参数 | Apifox 使用文档

 

Apifox 好东西

与Apifox:成熟的测试工具要学会自己写接口文档相似的内容: