JsonPath (json-path 5.0.1 API)

java.lang.Object
- io.restassured.path.json.JsonPath

public class JsonPath
extends Object

JsonPath is an alternative to using XPath for easily getting values from a Object document. It follows the Groovy GPath syntax when getting an object from the document. You can regard it as an alternative to XPath for JSON. E.g. given the following Object document:

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

To get a list of all book categories:

 List<String> categories = with(Object).get("store.book.category");

Get the first book category:

 String category = with(Object).get("store.book[0].category");

Get the last book category:

 String category = with(Object).get("store.book[-1].category");

Get all books with price between 5 and 15:

 List<Map> books = with(Object).get("store.book.findAll { book -> book.price >= 5 && book.price <= 15 }");

The JsonPath implementation of rest-assured uses a Groovy shell to evaluate expressions so be careful when injecting user input into the expression. For example avoid doing this:

 String name = System.console().readLine();
 List<Map> books = with(Object).get("store.book.findAll { book -> book.author == " + name + " }");

Instead use the param(java.lang.String, java.lang.Object) method like this:

 String name = System.console().readLine();
 List<Map> books = with(Object).param("name", name).get("store.book.findAll { book -> book.author == name }");

Field Summary

Fields
Modifier and Type Field and Description

static JsonPathConfig config

Fields
Modifier and Type	Field and Description
`static JsonPathConfig`	`config`

Constructor Summary

Constructors
Constructor and Description
`JsonPath(File file)` Instantiate a new JsonPath instance.
`JsonPath(InputStream stream)` Instantiate a new JsonPath instance.
`JsonPath(Reader reader)` Instantiate a new JsonPath instance.
`JsonPath(String text)` Instantiate a new JsonPath instance.
`JsonPath(URL url)` Instantiate a new JsonPath instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`JsonPath`	`and()` Syntactic sugar.
`static JsonPath`	`from(File file)` Instantiate a new JsonPath instance.
`static JsonPath`	`from(InputStream stream)` Instantiate a new JsonPath instance.
`static JsonPath`	`from(Reader reader)` Instantiate a new JsonPath instance.
`static JsonPath`	`from(String text)` Instantiate a new JsonPath instance.
`static JsonPath`	`from(URL url)` Instantiate a new JsonPath instance.
`<T> T`	`get()` Get a Object graph with no named root element as a Java object.
`<T> T`	`get(String path)` Get the result of an Object path expression as a boolean.
`boolean`	`getBoolean(String path)` Get the result of an Object path expression as a boolean
`byte`	`getByte(String path)` Get the result of an Object path expression as a byte.
`char`	`getChar(String path)` Get the result of an Object path expression as a char.
`double`	`getDouble(String path)` Get the result of an Object path expression as a double.
`float`	`getFloat(String path)` Get the result of an Object path expression as a float.
`int`	`getInt(String path)` Get the result of an Object path expression as an int.
`<T> T`	`getJsonObject(String path)`
`<T> List<T>`	`getList(String path)` Get the result of an Object path expression as a list.
`<T> List<T>`	`getList(String path, Class<T> genericType)` Get the result of an Object path expression as a list.
`long`	`getLong(String path)` Get the result of an Object path expression as a long.
`<K,V> Map<K,V>`	`getMap(String path)` Get the result of an Object path expression as a map.
`<K,V> Map<K,V>`	`getMap(String path, Class<K> keyType, Class<V> valueType)` Get the result of an Object path expression as a map.
`<T> T`	`getObject(String path, Class<T> objectType)` Get the result of a Object path expression as a java Object.
`<T> T`	`getObject(String path, io.restassured.common.mapper.TypeRef<T> typeRef)` Get the result of a Object path expression as a java Object with generic type.
`short`	`getShort(String path)` Get the result of an Object path expression as a short.
`String`	`getString(String path)` Get the result of an Object path expression as a string.
`UUID`	`getUUID(String path)` Get the result of an Object path expression as a UUID.
`static JsonPath`	`given(File file)` Instantiate a new JsonPath instance.
`static JsonPath`	`given(InputStream stream)` Instantiate a new JsonPath instance.
`static JsonPath`	`given(Reader reader)` Instantiate a new JsonPath instance.
`static JsonPath`	`given(String text)` Instantiate a new JsonPath instance.
`static JsonPath`	`given(URL url)` Instantiate a new JsonPath instance.
`JsonPath`	`param(String key, Object value)` Add a parameter for the expression.
`JsonPath`	`peek()` Peeks into the JSON that JsonPath will parse by printing it to the console.
`String`	`prettify()` Get the JSON as a prettified string.
`JsonPath`	`prettyPeek()` Peeks into the JSON that JsonPath will parse by printing it to the console in a prettified manner.
`String`	`prettyPrint()` Get and print the JSON as a prettified string.
`static void`	`reset()` Resets static JsonPath configuration to default values
`JsonPath`	`setRoot(String rootPath)` Deprecated. Use `setRootPath(String)` instead
`JsonPath`	`setRootPath(String rootPath)` Set the root path of the document so that you don't need to write the entire path.
`JsonPath`	`using(GsonObjectMapperFactory factory)` Configure JsonPath to use a specific Gson object mapper factory
`JsonPath`	`using(Jackson1ObjectMapperFactory factory)` Configure JsonPath to use a specific Jackson object mapper factory
`JsonPath`	`using(Jackson2ObjectMapperFactory factory)` Configure JsonPath to use a specific Jackson 2 object mapper factory
`JsonPath`	`using(JsonPathConfig config)` Configure JsonPath to with a specific JsonPathConfig.
`static JsonPath`	`with(File file)` Instantiate a new JsonPath instance.
`static JsonPath`	`with(InputStream stream)` Instantiate a new JsonPath instance.
`static JsonPath`	`with(Reader reader)` Instantiate a new JsonPath instance.
`static JsonPath`	`with(String text)` Instantiate a new JsonPath instance.
`static JsonPath`	`with(URL url)` Instantiate a new JsonPath instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - config
```
public static JsonPathConfig config
```
- Constructor Detail
  - JsonPath
```
public JsonPath(String text)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    text - The text containing the Object document
  - JsonPath
```
public JsonPath(URL url)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    url - The url containing the Object document
  - JsonPath
```
public JsonPath(InputStream stream)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    stream - The stream containing the Object document
  - JsonPath
```
public JsonPath(File file)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    file - The file containing the Object document
  - JsonPath
```
public JsonPath(Reader reader)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    reader - The reader containing the Object document
- Method Detail
  - get
```
public <T> T get()
```
    Get a Object graph with no named root element as a Java object. This is just a short-cut for
```
     get("");
 
```
    or
```
     get("$");
 
```
    Returns:
    
    The object matching the Object graph. This may be any primitive type, a List or a Map. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - get
```
public <T> T get(String path)
```
    Get the result of an Object path expression as a boolean.
    
    Parameters:
    
    path - The Object path.
    
    Returns:
    
    The object matching the Object path. This may be any primitive type, a List or a Map. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getBoolean
```
public boolean getBoolean(String path)
```
    Get the result of an Object path expression as a boolean
    
    Parameters:
    
    path - The Object path.
    
    Returns:
    
    The object matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getChar
```
public char getChar(String path)
```
    Get the result of an Object path expression as a char.
    
    Parameters:
    
    path - The Object path.
    
    Returns:
    
    The object matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getInt
```
public int getInt(String path)
```
    Get the result of an Object path expression as an int.
    
    Parameters:
    
    path - The Object path.
    
    Returns:
    
    The int matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getByte
```
public byte getByte(String path)
```
    Get the result of an Object path expression as a byte.
    
    Parameters:
    
    path - The Object path.
    
    Returns:
    
    The object matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getShort
```
public short getShort(String path)
```
    Get the result of an Object path expression as a short.
    
    Parameters:
    
    path - The Object path.
    
    Returns:
    
    The object matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getFloat
```
public float getFloat(String path)
```
    Get the result of an Object path expression as a float.
    
    Parameters:
    
    path - The Object path.
    
    Returns:
    
    The object matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getDouble
```
public double getDouble(String path)
```
    Get the result of an Object path expression as a double.
    
    Parameters:
    
    path - The Object path.
    
    Returns:
    
    The object matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getLong
```
public long getLong(String path)
```
    Get the result of an Object path expression as a long.
    
    Parameters:
    
    path - The Object path.
    
    Returns:
    
    The object matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getString
```
public String getString(String path)
```
    Get the result of an Object path expression as a string.
    
    Parameters:
    
    path - The Object path.
    
    Returns:
    
    The object matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getUUID
```
public UUID getUUID(String path)
```
    Get the result of an Object path expression as a UUID.
    
    Parameters:
    
    path - The Object path.
    
    Returns:
    
    The object matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getList
```
public <T> List<T> getList(String path)
```
    Get the result of an Object path expression as a list.
    
    Type Parameters:
    
    T - The list type
    
    Parameters:
    
    path - The Object path.
    
    Returns:
    
    The object matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getList
```
public <T> List<T> getList(String path,
                           Class<T> genericType)
```
    Get the result of an Object path expression as a list.
    
    Type Parameters:
    
    T - The type
    
    Parameters:
    
    path - The Object path.
    
    genericType - The generic list type
    
    Returns:
    
    The object matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getMap
```
public <K,V> Map<K,V> getMap(String path)
```
    Get the result of an Object path expression as a map.
    
    Type Parameters:
    
    K - The type of the expected key
    
    V - The type of the expected value
    
    Parameters:
    
    path - The Object path.
    
    Returns:
    
    The map matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getMap
```
public <K,V> Map<K,V> getMap(String path,
                             Class<K> keyType,
                             Class<V> valueType)
```
    Get the result of an Object path expression as a map.
    
    Type Parameters:
    
    K - The type of the expected key
    
    V - The type of the expected value
    
    Parameters:
    
    path - The Object path.
    
    keyType - The type of the expected key
    
    valueType - The type of the expected value
    
    Returns:
    
    The map matching the Object path. A ClassCastException will be thrown if the object cannot be casted to the expected type.
  - getObject
```
public <T> T getObject(String path,
                       Class<T> objectType)
```
    Get the result of a Object path expression as a java Object. E.g. given the following Object document:
```
 { "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
    }
  }
 }
 
```
    And a Java object like this:
```
 public class Book {
      private String category;
      private String author;
      private String title;
      private String isbn;
      private float price;

      public String getCategory() {
         return category;
      }

     public void setCategory(String category) {
         this.category = category;
     }

    public String getAuthor() {
          return author;
     }

    public void setAuthor(String author) {
         this.author = author;
    }

    public String getTitle() {
         return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getIsbn() {
             return isbn;
    }

    public void setIsbn(String isbn) {
          this.isbn = isbn;
    }

    public float getPrice() {
        return price;
    }

    public void setPrice(float price) {
             this.price = price;
   }
 }
 
```
    Then
```
 Book book = from(Object).getObject("store.book[2]", Book.class);
 
```
    maps the second book to a Book instance.
    Type Parameters:
    
    T - The type of the expected object
    
    Parameters:
    
    path - The path to the object to map
    
    objectType - The class type of the expected object
    
    Returns:
    
    The object
  - getObject
```
public <T> T getObject(String path,
                       io.restassured.common.mapper.TypeRef<T> typeRef)
```
    Get the result of a Object path expression as a java Object with generic type. E.g. given the following Object document:
```
 { "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
    }
  }
 }
 
```
    And you want to get a book as a Map<String, Object>:
    Then
```
 Map<String, Object> book = from(Object).getObject("store.book[2]", new TypeRef<Map<String, Object>>() {});
 
```
    maps the second book to a Book instance.
    Type Parameters:
    
    T - The type of the expected object
    
    Parameters:
    
    path - The path to the object to map
    
    typeRef - The class type of the expected object
    
    Returns:
    
    The object
  - param
```
public JsonPath param(String key,
                      Object value)
```
    Add a parameter for the expression. Example:
```
 String name = System.console().readLine();
 List<Map> books = with(Object).param("name", name).get("store.book.findAll { book -> book.author == name }");
 
```
    Parameters:
    
    key - The name of the parameter. Just use this name in your expression as a variable
    
    value - The value of the parameter
    
    Returns:
    
    New JsonPath instance with the parameter set
  - peek
```
public JsonPath peek()
```
    Peeks into the JSON that JsonPath will parse by printing it to the console. You can continue working with JsonPath afterwards. This is mainly for debug purposes. If you want to return a prettified version of the content see prettify(). If you want to return a prettified version of the content and also print it to the console use prettyPrint().
    
    Note that the content is not guaranteed to be looking exactly like the it does at the source. This is because once you peek the content has been downloaded and transformed into another data structure (used by JsonPath) and the JSON is rendered from this data structure.
    
    Returns:
    
    The same JsonPath instance
  - prettyPeek
```
public JsonPath prettyPeek()
```
    Peeks into the JSON that JsonPath will parse by printing it to the console in a prettified manner. You can continue working with JsonPath afterwards. This is mainly for debug purposes. If you want to return a prettified version of the content see prettify(). If you want to return a prettified version of the content and also print it to the console use prettyPrint().
    
    Note that the content is not guaranteed to be looking exactly like the it does at the source. This is because once you peek the content has been downloaded and transformed into another data structure (used by JsonPath) and the JSON is rendered from this data structure.
    
    Returns:
    
    The same JsonPath instance
  - prettify
```
public String prettify()
```
    Get the JSON as a prettified string.
    Note that the content is not guaranteed to be looking exactly like the it does at the source. This is because once you peek the content has been downloaded and transformed into another data structure (used by JsonPath) and the JSON is rendered from this data structure.
    
    Returns:
    
    The JSON as a prettified String.
  - prettyPrint
```
public String prettyPrint()
```
    Get and print the JSON as a prettified string.
    Note that the content is not guaranteed to be looking exactly like the it does at the source. This is because once you peek the content has been downloaded and transformed into another data structure (used by JsonPath) and the JSON is rendered from this data structure.
    
    Returns:
    
    The JSON as a prettified String.
  - using
```
public JsonPath using(GsonObjectMapperFactory factory)
```
    Configure JsonPath to use a specific Gson object mapper factory
    
    Parameters:
    
    factory - The gson object mapper factory instance
    
    Returns:
    
    a new JsonPath instance
  - using
```
public JsonPath using(Jackson1ObjectMapperFactory factory)
```
    Configure JsonPath to use a specific Jackson object mapper factory
    
    Parameters:
    
    factory - The Jackson object mapper factory instance
    
    Returns:
    
    a new JsonPath instance
  - using
```
public JsonPath using(Jackson2ObjectMapperFactory factory)
```
    Configure JsonPath to use a specific Jackson 2 object mapper factory
    
    Parameters:
    
    factory - The Jackson 2 object mapper factory instance
    
    Returns:
    
    a new JsonPath instance
  - using
```
public JsonPath using(JsonPathConfig config)
```
    Configure JsonPath to with a specific JsonPathConfig.
    
    Parameters:
    
    config - The JsonPath config
    
    Returns:
    
    a new JsonPath instance
  - and
```
public JsonPath and()
```
    Syntactic sugar.
    
    Returns:
    
    The same JsonPath instance.
  - given
```
public static JsonPath given(String text)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    text - The text containing the Object document
  - given
```
public static JsonPath given(InputStream stream)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    stream - The stream containing the Object document
  - given
```
public static JsonPath given(File file)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    file - The file containing the Object document
  - given
```
public static JsonPath given(Reader reader)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    reader - The reader containing the Object document
  - given
```
public static JsonPath given(URL url)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    url - The URL containing the Object document
  - with
```
public static JsonPath with(InputStream stream)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    stream - The stream containing the Object document
  - with
```
public static JsonPath with(String text)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    text - The text containing the Object document
  - with
```
public static JsonPath with(File file)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    file - The file containing the Object document
  - with
```
public static JsonPath with(Reader reader)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    reader - The reader containing the Object document
  - with
```
public static JsonPath with(URL url)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    url - The URI containing the Object document
  - from
```
public static JsonPath from(InputStream stream)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    stream - The stream containing the Object document
  - from
```
public static JsonPath from(String text)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    text - The text containing the Object document
  - from
```
public static JsonPath from(File file)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    file - The file containing the Object document
  - from
```
public static JsonPath from(Reader reader)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    reader - The reader containing the Object document
  - from
```
public static JsonPath from(URL url)
```
    Instantiate a new JsonPath instance.
    
    Parameters:
    
    url - The URI containing the Object document
  - setRoot
```
@Deprecated
public JsonPath setRoot(String rootPath)
```
    Deprecated. Use setRootPath(String) instead
    Set the root path of the document so that you don't need to write the entire path. E.g.
```
 final JsonPath jsonPath = new JsonPath(Object).setRoot("store.book");
 assertThat(jsonPath.getInt("size()"), equalTo(4));
 assertThat(jsonPath.getList("author", String.class), hasItem("J. R. R. Tolkien"));
 
```
    Parameters:
    
    rootPath - The root path to use.
  - setRootPath
```
public JsonPath setRootPath(String rootPath)
```
    Set the root path of the document so that you don't need to write the entire path. E.g.
```
 final JsonPath jsonPath = new JsonPath(Object).setRootPath("store.book");
 assertThat(jsonPath.getInt("size()"), equalTo(4));
 assertThat(jsonPath.getList("author", String.class), hasItem("J. R. R. Tolkien"));
 
```
    Parameters:
    
    rootPath - The root path to use.
  - getJsonObject
```
public <T> T getJsonObject(String path)
```
  - reset
```
public static void reset()
```
    Resets static JsonPath configuration to default values

Class JsonPath

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

config

Constructor Detail

JsonPath

JsonPath

JsonPath

JsonPath

JsonPath

Method Detail

get

get

getBoolean

getChar

getInt

getByte

getShort

getFloat

getDouble

getLong

getString

getUUID

getList

getList

getMap

getMap

getObject

getObject

param

peek

prettyPeek

prettify

prettyPrint

using

using

using

using

and

given

given

given

given

given

with

with

with

with

with

from

from

from

from

from

setRoot

setRootPath

getJsonObject

reset