Apifox 如何发送 json 格式的 post 请求?

Apifox 如何发送 json 格式的 post 请求?

JSON 是一种轻量级的数据格式,可以用于将数据存储为键值对,并且可以通过 JavaScript 对象表达。JSON 格式的重要性在于它的易于解析和生成,且在网络上广泛被使用,使其成为了一种标准的数据交换格式。JSON 格式在 API 中广泛应用,用于传输数据,以及表达 API 的请求和响应。


本文来讲解一下如何在 Apifox 中发送 JSON 格式的 POST 请求。

1.新建 Post 请求

在 Apifox 中新建一个 HTTP 项目,然后在项目中新建一个接口,接口类型选择为 Post 请求。

Apifox 发送 json 格式的 post 请求

然后输入 API 地址,比如后端提供的地址为http://localhost:8000/items,接着填写接口名字。

Apifox 发送 json 格式的 post 请求

2.编写 JSON 数据的结构和内容

上一步完成后,就可以编写 JSON 数据的结构和内容了,依次点击【Body->json】,在这里,你需要设计接口的入参,例如一个接口在发起请求的时候需要携带以下的 json 请求体:

{
    "id": 2,
    "name": "西瓜",
    "price": 5
}

我们可以看出这个请求体最外层是一个对象(Object),然后对象里面包含了键值对,这样的设计如下图所示,你需要在“数据结构”这里填写参数名和选择参数类型。

Apifox 发送 json 格式的 post 请求


如果你的接口还需要鉴权,可以在 Auth 页中设置凭证。

Apifox 发送 json 格式的 post 请求

当接口请求需要的入参、凭证等信息都配置完毕,就可以点击保存了。

3.发送请求

保存后来到【运行】页,在该页面依次点击【Body->json】,然后点击【自动生成】,Apifox 就会根据你刚才在文档中设计的 JSON 结构智能生成数据。最后点击【发送】按钮,这样,我们就完成了在 Post 请求接口中发送 JSON 数据的任务。

Apifox 发送 json 格式的 post 请求


如果没有在文档中定义 JSON 的数据结构,或者与文档中定义的数据结构不符,就会提示"不一致"。


比如下图就没有在文档中定义 JSON 的数据结构,直接把 JSON 数据粘贴到请求体中,就会提示“不一致”。当然这并不影响接口的请求与响应,只是一种提示,提示你这里的入参跟接口文档定义的数据结构不一致,需要注意。

Apifox 发送 json 格式的 post 请求

总结


本文详细介绍了在 Apifox 中发送 JSON 格式的 POST 请求的步骤。通过创建 HTTP 项目、新建 POST 请求接口、编写 JSON 数据结构和内容,以及设置参数和鉴权信息,就可以轻松完成接口的配置。在运行阶段,Apifox 会智能生成数据,并通过提示确保用户的输入与文档定义一致,最终实现了在 POST 请求接口中发送 JSON 数据的任务。

知识扩展:

订阅
qrcode

订阅

随时随地获取 Apifox 最新动态