Apifox 中如何指定 query 参数

本文详细讲解了如何在 Apifox 指定 query 参数。

用 Apifox,节省研发团队的每一分钟

Apifox 中如何指定 query 参数

免费使用 Apifox

相关推荐

最新文章

API

一体化协作平台

API 设计

API 文档

API 调试

自动化测试

API Mock

API Hub

立即体验 Apifox
目录

在项目的开发过程中,通常会使用 path 来区分不同的业务数据。但有的开发项目(例如一些电商 API 文档),接口请求的 URL 是不变的,一般通过 Query 或 Header 中的参数来做区分。如果有大量的接口需要指定 Query,那么在测试接口的过程中可以进行统一设置。这样的业务需求可以通过 Apifox 的 接口唯一标识 来完成,具体操作请看下文。

设置接口唯一标识

接口唯一标识 在 Apifox 中被定义为目录层级的设置。也就是说,当你需要定义某个接口的唯一标识的时候,需要在该接口的 父级目录 中设置。根据你的项目需求,在目录设置的选项下选择你需要的唯一标识参数,然后点击保存,即可对该目录下的所有接口生效。

设置接口唯一标识
举个例子:一个项目中某个模块的 API 接口,接口中返回的业务数据通过一个叫做 action 的 query 参数来区分,所以下面我们通过Query 参数来定义接口唯一标识

如下图所示,将下图的接口唯一标识选择为 Query 参数 后,在其右侧的输入框中输入对应的参数名,点击保存即可设置成功。

设置成功

填写对应的唯一标识的参数值

设置完 接口唯一标识 后,选择该目录下的某个接口,Apifox 会提示你输入参数名为 action 的值,填写后即可发起请求。

填写对应的唯一标识的参数值

如果你需要调用该目录下的其他接口,操作方式也同上面描述一样。Apifox 会自动为你添加查询参数,省去了逐个手动添加的繁琐步骤,让你的工作更加高效!

总结

对于接口的 path 和 Method 都一样,只通过 query 参数来做业务数据区分的接口,Apifox 的 接口唯一标识 可以满足你的应用需求。想要了解更多相关的知识,比如接口的导入、Mock 数据自动化测试等功能,可以访问 Apifox 的帮助文档