【接口文档】怎么看接口的参数是params还是data

提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档


前言

对于后端发来的接口文档
前端在api文件里注册接口时
经常会有疑惑
在这里插入图片描述
在这里插入图片描述
函数后面的参数究竟是写 params 还是 data
好像这两种都在其他项目里看到过
但是不会区分要怎么用
在写这篇文章之前 我都是看运气用的
但是今天出现了 Request failed with status code 400 的错误
找了好久无果 才意识到可能是params和data的问题
所以记录一下


区别

params 添加到url的请求字符串中 -> get请求
data 添加到请求体(body)中 -> post请求

但实际上,我们也会在发送post请求时,使用params方式传值

接口文档

1、params

可以看到下图中的请求类型是query,是?的意思
就说明传递参数的时候,是直接跟在url后面,用?进行连接的
所以函数的参数使用params
在这里插入图片描述

2、data

可以看到下图中的请求类型是body
参数是添加到请求体(body)的
所以函数的参数使用data
在这里插入图片描述

  • 2
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
你可以使用Postman实战项目接口文档来记录和测试API接口。以下是一个简单的步骤: 1. 安装Postman:首先,你需要在你的计算机上安装Postman应用程序。它可以在Postman的官方网站上免费下载。 2. 创建一个新的项目:在Postman中,点击左上角的"New"按钮,然后选择"New Collection"。给你的项目起一个名称,并添加一个合适的描述。 3. 添加请求:在你的项目中,点击右上角的"Add Request"按钮。给你的请求起一个名字,并选择请求的方法(GET、POST、PUT等)和URL。 4. 添加请求参数:如果你的请求需要提供参数,可以点击"Params"选项卡,并添加键值对参数。根据需要选择参数类型(query、header等)。 5. 添加请求头:如果你的请求需要特定的请求头,可以点击"Headers"选项卡,并添加键值对header。 6. 添加请求体:对于POST和PUT请求,你可能需要在"Body"选项卡中提供请求体数据。根据需要选择请求体格式(JSON、form-data等)并提供相应数据。 7. 发送请求:一切准备就绪后,点击发送按钮发送你的请求。你将收到服务器返回的响应,包括状态码、响应头和响应体。 8. 保存接口文档:在完成请求和测试之后,你可以在Postman中保存接口文档。点击右上角的"Save"按钮,并选择一个合适的位置和文件格式(如JSON或Markdown)。 这只是一个简单的介绍,Postman还有许多其他功能,如集成测试、环境变量、身份验证等。你可以根据自己的需求,进一步探索和使用Postman。希望对你有所帮助!
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值