JSONPath Match Assertion

To avoid typing the desired JSONPath expression manually, click and select the desired JSON element or attribute in the subsequent dialog.

ReadyAPI will form the JSONPath expression that refers the selected item, and will set the result from the last request or response as the expected result.

ASP.NET-based services enclose the JSON response payload into the d root element for security reasons. By default, ReadyAPI does not strip the d element out, but there is an option to automatically remove it. If you turn this option on, JSON-related assertions created from the JSON response will not take the root element into account, which can cause the assertion to fail unexpectedly.

The assertion ignores the excessive spaces and line breaks within JSON expressions. Use any type of markup you find suitable. For example, the following code:

is treated as identical to this one:

JSONPath expressions can return either a single value or an array, depending on the expression syntax:

• Expression containing filters ([?(filter)] and array slices ([start:end] always returns arrays, even if the resulting array contains a single item. For example:

  $.section.fields.item[?(@.name=='My Field')].fldValue

  – will return an array even if the fldValue element has one value only. To get this value, add an index to the expression:

  $.section.fields.item[?(@.name=='My Field')].fldValue[0]

• Object wildcards will return an array only if the object has 2 or more properties. Otherwise, these will return a value of the single property (this value will keep the initial type). For example, assume that you need to obtain properties of the following object:

  {
    "section": {
      "first_subsection": {
        "name": "titular"
      },
      "second_subsection": {
        "name": "secondary",
        "contains_images": true
      }
    }
  }

  The following expression will return a titular string:

  $.section.first_subsection.*
  
  // The first_subsection element has a single property

  The following expression will return an array:

  $.section.second_subsection.*
  
  // Returns ["name": "secondary", "contains_images": true"]

• The behavior of the array wildcards (arr[*]) depends on which ReadyAPI version you use:

  • In ReadyAPI 2.3.0 and later: Array wildcards should always return an array. For the preceding example, the following expression:

    $.section.first_subsection[*]

    – will return an array:

    ["name": "titular"]

  • In ReadyAPI 1.9.0 – 2.2.0: Array wildcards return an array only if the original array includes more than 2 items. For the arrays including a single item, the results vary depending on the item type.

    For example, for the following objects:

    {
      "section": ["content"],
      "second_section": [ {"number": 2} ]
    }

    the JSONPath expressions will work as follows:

    $.section[*] = content // A string $.second_section[*] = [ {"number": 2} ] // An array