技术文档HTTP 请求参数类型

HTTP 请求参数类型

后端HTTP网络
内容

请求体参数类型

在 HTTP 请求里常见的几个参数位置分别代表不同的含义，通常有以下区别：

  1. Query 参数

    • 指的是 URL 中 ? 之后以 key=value 形式出现的参数，例如 https://api.example.com/users?role=admin&age=18。
    • 这些参数通常用于对资源进行过滤、搜索、排序等操作。
    • 一般在 GET 请求里用得比较多，但实际上在任何 HTTP 方法中都可以携带。

  2. Path 参数

    • 指的是在 URL "路径"部分，用来表示某些动态的或可变的资源标识，例如 https://api.example.com/users/123 中的 123 就是一个 Path 参数。
    • 如果 API 文档中写成 /users/{userId}，那么 {userId} 就是典型的 Path 参数形式，用于标识要操作的特定资源。
    • Path 参数通常直接嵌在 URL 里，一般与资源标识或层级结构相关。

  3. Body 参数

    • 指的是放在 HTTP 请求体（Request Body）中的数据，比如在 POST 或 PUT 等请求方式中常见的 JSON、Form 或 XML 等格式的数据。
    • 这种形式适用于传输体量较大或结构化（如嵌套）的数据，不适合放到 Query 里，也不适合当作 Path 参数。

简而言之，Path 参数多用于标识资源或资源层级，Query 参数用于对资源进行过滤、分页或其他附加操作，Body 参数则适用于传输大块或复杂的数据内容。