REST API/请求格式

请求格式

了解如何使用参数、请求头和请求体构造 API 请求

请求组成

API 请求可以在四个不同位置包含参数:路径参数、查询参数、请求头和请求体。了解每种参数的放置位置对于成功集成 API 至关重要。

路径参数

路径参数是 URL 路径的一部分,用于标识特定资源。它们是必填的,在 API 参考中以花括号表示:

路径参数
始终必填,不可省略
包含特殊字符时必须进行 URL 编码
通常用于资源标识符(ID、slug)

查询参数

查询参数附加在 URL 问号(?)之后,用 & 符号(&)分隔。通常是可选的,用于过滤、分页和排序:

查询参数
通常可选,有默认值
必须进行 URL 编码(空格变为 %20)
适合简单的过滤和分页

请求头

请求头提供请求的元数据,包括鉴权凭证、内容类型和自定义追踪信息:

请求头

必填请求头

  • Authorization— Bearer Token 格式的 API 密钥
  • Content-Type— POST/PUT 请求必须为 application/json

可选请求头

  • Accept— 期望的响应格式(默认:application/json)
  • X-Request-ID— 用于请求追踪和调试的自定义标识符

请求体

请求体包含 POST 和 PUT 请求的主要数据载荷。必须是有效的 JSON 格式,并包含所有必填字段:

请求体(JSON)
必须是有效的 JSON 格式
用于复杂查询和数据结构
支持嵌套对象和数组

最佳实践

  • 发送请求前始终验证 JSON 格式
  • 对包含特殊字符的路径参数和查询参数进行 URL 编码
  • 包含 X-Request-ID 以便于调试
  • 复杂查询使用请求体而非冗长的查询字符串