• JSONPath Syntax
  • JSONPath notation
  • Filters
  • Examples
  • Considerations for JSONPath expressions that return multiple elements
  • FAQ
  • See Also

JSONPath Syntax

文档原文地址： https://support.smartbear.com/alertsite/docs/monitors/api/endpoint/jsonpath.html#filters

Last modified on November 22, 2021

JSONPath is a query language for JSON, similar to XPath for XML. AlertSite API endpoint monitors let you use JSONPath in assertions to specify the JSON fields that need to be verified.

JSONPath notation

A JSONPath expression specifies a path to an element (or a set of elements) in a JSON structure. Paths can use the dot notation:

$.store.book[0].title

or the bracket notation:

$['store']['book'][0]['title']

or a mix of dot and bracket notations:

$['store'].book[0].title

Note that dots are only used before property names not in brackets.

The leading $ represents the root object or array and can be omitted. For example, $.foo.bar and foo.bar are the same, and so are $[0].status and [0].status.

Other syntax elements are described below.

Notes:

• JSONPath expressions, including property names and values, are case-sensitive.
• Unlike XPath, JSONPath does not have operations for accessing parent or sibling nodes from the given node.

Filters

Filters are logical expressions used to filter arrays. An example of a JSONPath expression with a filter is

$.store.book[?(@.price < 10)]

where @ represents the current array item or object being processed. Filters can also use $ to refer to the properties outside of the current object:

$.store.book[?(@.price < $.expensive)]

An expression that specifies just a property name, such as [?(@.isbn)], matches all items that have this property, regardless of the value.

Below are the operators that can be used in filters.

	Supported operators depend on the monitor playback engine.

Examples

For these examples, we will use a modified version of JSON from http://goessner.net/articles/JsonPath/index.html#e3:

{
 "store": {
  "book": [
   {
    "category": "reference",
    "author": "Nigel Rees",
    "title": "Sayings of the Century",
    "price": 8.95
   },
   {
    "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
  }
 },
 "expensive": 10
}

In all these examples, the leading $. is optional and can be omitted.

Considerations for JSONPath expressions that return multiple elements

JSONPath queries can return not just a single element, but also a list of matching elements. For example, given this JSON:

{
 "name": "Rose Kolodny",
 "phoneNumbers": [
  {
   "type": "home",
   "number": "954-555-1234"
  },
  {
   "type": "work",
   "number": "754-555-5678"
  }
 ]
}

the JSONPath expression

phoneNumbers[*].number

returns a list containing two phone numbers:

[954-555-1234, 754-555-5678]

Note that this is not a JSON array, it is just a comma-separated list of items where [ ] indicates the beginning and end of the list.

When using “equals” assertions against a list of matches, specify a list of expected values enclosed in [ ] and separated by a comma and one space:

[apples, 15, false, ["foo","bar"], {"status":"ok"}]

Standalone strings (like apples) should not have enclosing quotes, unless the quotes are part of the value.

[Example](javascript:ShowExample("IDM5MMQY3TEHZ3II3HWNFO25ANWOEHQ3ZZ4JJWGOGW5P4BFEH421SP_id", "IDM5MMQY3TEHZ3II3HWNFO25ANWOEHQ3ZZ4JJWGOGW5P4BFEH421SP_div"))

Values that are JSON arrays and objects keep inner quotes, but are minified with no spaces between their items: ["foo","bar"], not [ "foo" , "bar" ].

FAQ

How can I check that my JSONPath syntax is valid?

If you have ReadyAPI 1.9, you can create a test for your API endpoint, add a JSONPath Match assertion and test the syntax in the assertion editor there.

Otherwise, you can use http://jsonpath.herokuapp.com and check the results on the Jayway tab. However, the syntax used on this site may be slightly different from the one used in AlertSite.

See Also

API Assertions
Creating an API Endpoint Monitor
API Endpoint Monitor Settings