JSONPath

JSONPath là một ngôn ngữ truy vấn được thiết kế để trích xuất thông tin từ các cấu trúc dữ liệu JSON, tương tự như cách XPath hoạt động với XML. Trong Apidog, JSONPath được sử dụng rộng rãi để trích xuất giá trị từ phản hồi API, xác thực dữ liệu và tạo các khẳng định kiểm thử động.

Phiên bản JSONPath được sử dụng trong Apidog dựa trên JSONPath Plus. Để xem giải thích cú pháp chi tiết hơn, bạn có thể truy cập liên kết được cung cấp.

Trình tạo JSONPath được hỗ trợ bởi AI

Nếu bạn chưa quen với JSONPath, bạn có thể sử dụng công cụ AI miễn phí này để tạo biểu thức.

Bắt đầu nhanh

Ví dụ về phản hồi JSON

Giả sử chúng ta có phản hồi JSON sau:

{
    "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" }
      ]
    }
}

Trích xuất dữ liệu

Để trích xuất title của book đầu tiên trong mảng, hãy sử dụng biểu thức JSONPath này:

 $.store.book[0].title

Biểu thức này trả về "Book 1".

Giải thích biểu thức JSONPath

Hãy phân tích biểu thức $.store.book[0].title:

$: Tham chiếu đến nút gốc của tài liệu JSON — về cơ bản là toàn bộ cấu trúc.

store: Trỏ đến thuộc tính store, là một đối tượng nằm dưới nút gốc.

book: Truy cập thuộc tính book dưới đối tượng store, đây là một mảng.

[0]: Chọn phần tử đầu tiên trong mảng book (chỉ mục bắt đầu từ 0).

title: Truy xuất title của cuốn sách đầu tiên trong mảng.

Tóm lại, biểu thức điều hướng từ gốc, tìm đối tượng store, truy cập mảng book, chọn mục đầu tiên và trích xuất title của mục đó.

Lưu ý quan trọng

Chỉ mục JSONPath bắt đầu từ 0.

Chuỗi trong JSONPath phải sử dụng dấu nháy đơn, ví dụ: $.store.book[?(@.category=='reference')].

Tổng quan cú pháp

Cú pháp cơ bản

Cú pháp	Mô tả
`$`	Nút gốc
`@`	Nút hiện tại
`.node` or `['node']`	Truy cập các nút con
`[index]`	Đánh chỉ mục mảng, hỗ trợ đếm từ `0`
`[start:end:step]`	Cắt mảng
`*`	Ký tự đại diện, khớp với tất cả các nút con
`..`	Ký tự đại diện đệ quy, khớp với tất cả các nút hậu duệ
`(<expr>)`	Biểu thức động
`?(<boolean expr>)`	Điều kiện lọc

Cú pháp mở rộng

Cú pháp	Mô tả
`^`	Truy cập phần tử cha của mục khớp
`~`	Lấy tên thuộc tính của mục khớp (dưới dạng mảng)
`@null()`, `@boolean()`, `@number()`, `@string()`, `@array()`, `@object()`	Truy xuất các kiểu JSON cơ bản
`@integer()`	Truy xuất kiểu số nguyên
`@scalar()`	Truy xuất các kiểu phức hợp, chấp nhận `undefined` và các số không hữu hạn (khi truy vấn đối tượng JavaScript)
`@other()`	Có thể được sử dụng với `otherTypeCallback` do người dùng định nghĩa
`@undefined()`, `@function()`, `@nonFinite()`	Các kiểu không phải JSON được sử dụng khi truy vấn đối tượng JavaScript không phải JSON
`@path`, `@parent`, `@property`, `@parentProperty`, `@root`	Bộ chọn viết tắt trong bộ lọc
`	Thoát các chuỗi còn lại
`@['...']`, `?@['...']`	Thoát các ký tự đặc biệt trong tên thuộc tính bên trong bộ lọc
`$..`	Truy xuất tất cả các thành phần cha

Ví dụ JSONPath

Dưới đây là một số biểu thức JSONPath phổ biến dựa trên dữ liệu JSON ví dụ:

Dữ liệu JSON ví dụ

{
  "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
    }
  }
}

Ví dụ truy vấn phổ biến

XPath	JSONPath	Kết quả
`/store/book/author`	`$.store.book[*].author`	Tác giả của tất cả sách
`//author`	`$..author`	Tất cả tác giả
`/store/*`	`$.store.*`	Tất cả các nút con dưới `store`
`/store//price`	`$.store..price`	Tất cả các trường giá
`//book[3]`	`$..book[2]`	Cuốn sách thứ ba (chỉ mục bắt đầu từ 0)
`//book[last()]`	`$..book[(@.length-1)]` or `$..book[-1:]`	Cuốn sách cuối cùng
`//book[position()<3]`	`$..book[:2]` or `$..book[0,1]`	Hai cuốn sách đầu tiên
`//book[isbn]`	`$..book[?(@.isbn)]`	Sách có ISBN
`//book[price<10]`	`$..book[?(@.price<10)]`	Sách có giá dưới 10
`//*`	`$..*`	Khớp đệ quy với tất cả các nút con

Kiểm thử biểu thức JSONPath

Bạn có thể xác minh các biểu thức này bằng trình kiểm thử JSONPath. Hãy đảm bảo chọn JSONPath Plus để xác thực.

Trường hợp sử dụng trong Apidog

JSONPath đặc biệt hữu ích trong Apidog cho:

Xác thực phản hồi: Trích xuất các giá trị cụ thể từ phản hồi API để xác minh tính chính xác

Biến động: Lưu trữ các giá trị đã trích xuất để sử dụng trong các yêu cầu tiếp theo

Khẳng định kiểm thử: Tạo các khẳng định mạnh mẽ dựa trên dữ liệu phản hồi

Trích xuất dữ liệu: Lấy các trường cụ thể từ các cấu trúc JSON lồng nhau phức tạp

Tài liệu tham khảo

JSONPath Plus

JSONPath - XPath for JSON

Querying JSON with SelectToken

Bắt đầu nhanh#

Tổng quan cú pháp#

Cú pháp cơ bản#

Cú pháp mở rộng#

Ví dụ JSONPath#

Dữ liệu JSON ví dụ#

Ví dụ truy vấn phổ biến#

Trường hợp sử dụng trong Apidog#

Tài liệu tham khảo#

Bắt đầu nhanh

Tổng quan cú pháp

Cú pháp cơ bản

Cú pháp mở rộng

Ví dụ JSONPath

Dữ liệu JSON ví dụ

Ví dụ truy vấn phổ biến

Trường hợp sử dụng trong Apidog

Tài liệu tham khảo