JSONPath 介绍

JSONPath 是一种用于从 JSON 数据结构中提取数据的查询语言，类似于 XPath 对 XML 的作用。Apifox 中使用的 JSONPath 基于 JSONPath Plus，你可以访问该链接查看详细的语法说明。

:::tip[]
如果不熟悉 JSONPath，可使用免费的 AI 工具生成表达式。
:::

快速入门

  ```json
  {
      "store": {
        "book": [
          { "category": "fiction", "author": "Author A", "title": "Book 1" },
          { "category": "reference", "author": "Author B", "title": "Book 2" },
          { "category": "fiction", "author": "Author C", "title": "Book 3" }
        ]
      }
  }

  ```

  如果你想快速提取 `book` 数组中第一本书的标题 *(`title`)*，可以使用以下 JSONPath：
  ```json
  $.store.book[0].title
  ```
  这将返回 `"Book 1"`。
  

<Step title="理解含义">
  这个 JSONPath 表达式 `$.store.book[0].title` 的含义是：

    - **`$`**：表示 JSON 文档的根节点。在这个例子中，它指向整个 JSON 数据结构。
    - **`store`**：访问根节点下的 `store` 属性，它是一个对象。
    - **`book`**：在 `store` 对象下访问 `book` 属性，它是一个数组。
    - **`[0]`**：访问 `book` 数组中的第一个元素（索引从 `0` 开始）。
    - **`title`**：访问数组中的第一个书籍对象的 `title` 属性。

    所以，整个表达式的意思是：从 JSON 文档的根节点开始，找到 `store` 对象，进入 `book` 数组，获取数组中的第一个元素，然后提取该元素的 `title` 属性值。

:::highlight purple 💡

• JSONPath 索引从 0 开始计数。
• JSONPath 中字符串必须使用单引号，例如：$.store.book[?(@.category=='reference')]。
  :::

语法详解

基本语法

扩展语法

JSONPath 示例

以下是基于示例 JSON 数据的常用 JSONPath 表达式：

示例 JSON 数据

{
  "store": {
    "book": [
      {
        "category": "reference",
        "author": "Nigel Rees",
        "title": "Sayings of the Century",
        "price": 8.95
      },
      {
        "category": "fiction",
        "author": "Evelyn Waugh",
        "title": "Sword of Honour",
        "price": 12.99
      },
      {
        "category": "fiction",
        "author": "Herman Melville",
        "title": "Moby Dick",
        "isbn": "0-553-21311-3",
        "price": 8.99
      },
      {
        "category": "fiction",
        "author": "J. R. R. Tolkien",
        "title": "The Lord of the Rings",
        "isbn": "0-395-19395-8",
        "price": 22.99
      }
    ],
    "bicycle": {
      "color": "red",
      "price": 19.95
    }
  }
}

JSONPath 查询示例

:::tip[]
你可以在 JSONPath 测试工具中验证这些表达式 *(验证时需选择 JSONPath Plus)*。