Apifox 中 Query 和 Path 参数如何填写?图文教程

Apifox 中 Query 和 Path 参数如何填写?图文教程

Query 参数和 Path 参数是 API 接口中常见的两种参数类型,Query 参数通常在 URL 中以键值对的形式显示,并且连接在 URL 的路径之后,以?字符开始,多个参数用&字符分隔。Path 参数则直接嵌入到 URL 路径中,通常用来指定特定资源的标识符。本文来介绍一下在 Apifox 中怎么设置这两种类型的参数。


以这个实际请求的接口为例:

http://localhost:3000/pet/findlist/cat?a=11&b=22

其中,http://localhost:3000作为请求的前置 URL,通常将其配置在 Apifox 的环境变量中;后面的/pet/findlist作为固定路径,因为 Path 参数是可变的,所以它的值可以是 cat、dog 等;Query 参数就是最后的?a=11&b=22。下面来讲一下它们在 Apifox 中的配置。

设置 Path 参数

首先在 Apifox 中新建一个 HTTP 项目,然后在项目中新建一条接口,填入/pet/findlist/,并给接口命名。

Apifox 中 Query 和 Path 参数填写

你可能会疑惑前面的http://localhost:3000为什么不在这里写,因为我们一般会把这个服务配置在环境变量里面,在后面进行调试时选择对应的环境,运行的时候 Apifox 就会自动带上。这样做的好处就是,一旦服务 URL 发生变更,直接在环境变量中改就可以了,省去了后续一个接口一个接口修改的麻烦。


点击页面右上角的图标打开环境管理,你可以将其配置在测试环境、开发环境或者其它环境中,填写完毕后保存即可。

Apifox 中 Query 和 Path 参数填写


要设置 Path 参数,你需要在路径中用大括号{}包裹里面的参数,比如填入{type},Apifox 就会自动生成一个参数名为type 的 Path 参数,你可以在下方填写它的示例值。如果要修改 Path 参数,你也需要在上方的 URL 上修改,简单一句话就是在哪里填入的,就在哪里修改。

Apifox 中 Query 和 Path 参数填写

设置 Query 参数


设置 Query 参数直接在 Params 里面设置就可以了,比如请求路径上的?a=11&b=22可以像下图表示,你也可以将这个命令粘贴到路径上,Apifox 会自动提取到下方的 Query 参数中。

Apifox 中 Query 和 Path 参数填写

发送请求


配置完毕后,点击“保存”按钮保存该接口,然后来到运行页面。填写相应的 Path 和 Query 参数值,然后发送请求来测试它们是否正确地被添加到了请求中。

Apifox 中 Query 和 Path 参数填写


最后它的实际请求是类似于这样的:

http://localhost:3000/pet/findlist/cat?a=11&b=22

总结


以上步骤是使用 Apifox 填写 Query 参数和 Path 参数的基本流程。根据你的 API 设计,你可以添加任意数量的参数,还可以设置其他选项比如 Header 参数、Cookie 参数等。Apifox 界面友好,应当很容易理解和操作,如果在使用过程中遇到问题,可以查看 Apifox 的官方帮助文档或联系我们的技术支持。

知识扩展:

订阅
qrcode

订阅

随时随地获取 Apifox 最新动态