当前位置:   article > 正文

API接口常用参数:路径参数、查询参数、请求参数、响应参数..._api接口参数

api接口参数

一、路径参数:用于标识资源的URL唯一标识符或标识特定资源的属性

  1. https://api.example.com/users/{userID}
  2. //路径参数拼接
  3. 1.
  4. export const delete = (id) =>
  5. defHttp.delete({ url: '/rscheck/v1/person/checkpersonmsg/' + id });
  6. 2.
  7. export const delete = (id) =>
  8. defHttp.delete({ url: `/rscheck/v1/person/checkpersonmsg/${id}` });
  9. //其中,id就是路径参数

二、查询参数:查询参数是在 URL 中通过 ? 后面附加的键值对形式传递的,不同参数之间使用 & 连接

  1. https://api.example.com/search?query=term&page=1&limit=10
  2. export const delete = (params) =>
  3. defHttp.delete({ url: '/rscheck/v1/person/checkpersonmsg/delete',params });
  4. //其中,params就是查询参数

三、请求头参数(Request Headers): 包含在HTTP请求头部中,用于传递额外的信息,例如授权信息、内容类型等

  1. GET /api/resource HTTP/1.1
  2. Host: example.com
  3. Authorization: Bearer your_access_token
  4. Content-Type: application/json

四、请求体参数(Request Body): 包含在HTTP请求体中,通常用于POST、PUT等请求方法,传递客户端向服务器提交的数据

  1. POST /api/resource HTTP/1.1
  2. Host: example.com
  3. Content-Type: application/json
  4. {
  5. "key": "value"
  6. }

五、响应头参数(Response Headers): 包含在HTTP响应头部中,用于传递响应的元数据,例如内容类型、缓存控制等

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. Cache-Control: no-cache

六、响应体参数(Response Body): 包含在HTTP响应体中,传递服务器对请求的响应数据

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. {
  4. "result": "success"
  5. }

七、授权参数(Authentication Parameters): 用于身份验证,例如用户名、密码、访问令牌等

  1. GET /api/resource HTTP/1.1
  2. Host: example.com
  3. Authorization: Basic base64encoded(username:password)

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/weixin_40725706/article/detail/839862
推荐阅读
相关标签
  

闽ICP备14008679号