One of the biggest strengths of XML is XPath, the query-oriented language to query subsections of an XML document. In the same line, JSONPath is a query language with features similar to XPath that lets you extract just the bits of a JSON document your application needs.
To use JSONPath, you will need to include its dependency and then use it.
JSONPath Syntax
As XPath, JSONPath also has syntax to follow:
$– symbol refers to the root object or element.@– symbol refers to the current object or element..– operator is the dot-child operator, which you use to denote a child element of the current element.[ ]– is the subscript operator, which you use to denote a child element of the current element (by name or index).*– operator is a wildcard, returning all objects or elements regardless of their names.,– operator is the union operator, which returns the union of the children or indexes indicated.:– operator is the array slice operator, so you can slice collections using the syntax[start:end:step]to return a subcollection of a collection.( )– operator lets you pass a script expression in the underlying implementation’s script language. It’s not supported by every implementation of JSONPath, however.? ( )– to query all items that meet a certain criteria.
e.g.
$.store.book[0].title $.store.book[*].title $..book[3] //or using brackets $['store']['book'][0].['title'] $['store']['book'][*].['title'] $..['book'][3] $.store.book[?(@.price < 10)].title
JSONPath Example
Let’s assume we have given JSON object and we want to apply JSONPath on it.
{ "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
}
}
}
Let’s apply some JSONPaths to above JSON object.
Example 1
var response = jsonPath(store , "$..author").toJSONString(); //Outpout: [ "Nigel Rees", "Evelyn Waugh", "Herman Melville", "J. R. R. Tolkien" ]
Example 2
var response = jsonPath(store , "$..book[3]").toJSONString();
//Outpout:
[
{
"category":"fiction",
"author":"J. R. R. Tolkien",
"title":"The Lord of the Rings",
"isbn":"0-395-19395-8",
"price":22.99
}
]
Live Example : Learn to build JSONPath expressions in line editor
JSONPath dependencies
| Language | Dependency |
|---|---|
| JavaScript | JSONPath JavaScript File |
| Node | npm install JSONPath |
| PHP | JSONPath PHP include file |
| Python | pip install jsonpath-rw |
| Java | <dependency> <groupId>com.jayway.jsonpath</groupId> <artifactId>json-path</artifactId> <version>2.0.0</version> </dependency> |
Reference: JSONPath – XPath for JSON
Teja says
[ { "firstName": "F1", "lastName": "L1", "address": [ { "city": "Atlanta", "country": "US" }, { "city": "Maidson", "country": "US" } ] }, { "firstName": "F2", "lastName": "L2", "address": [ { "city": "Nashville", "country": "US" }, { "city": "Vegas", "country": "US" } ] }, { "firstName": "F3", "lastName": "L3", "address": [ { "city": "Minneapolis", "country": "US" }, { "city": "Nashville", "country": "US" } ] } ]From the above data, how can I get person details who lived in Nashville for example. I am expecting the following result
[ { "firstName": "F2", "lastName": "L2", "address": [ { "city": "Nashville", "country": "US" }, { "city": "Vegas", "country": "US" } ] }, { "firstName": "F3", "lastName": "L3", "address": [ { "city": "Minneapolis", "country": "US" }, { "city": "Nashville", "country": "US" } ] } ]Thank you!
Rahul says
Can i transform the json string into another format. I want the JSON string to be transform into array of array where property name in book becomes the column names. ?
Sai says
Can i write regular expression to match the string in javascript. i saw it working in jay way which is for java but in javascript its not working.
Admin says
Yes,
string.match(regex)takes regular expression in javascript.nshah says
How do I write back to json file using JSONPath ?
John says
nshah I don’t think it is possible to write json elements using JSONPath. Otherwise, it would surely be listed on this page.
Test says
{
“kind”: “storage#policy”,
“resourceId”: “test1”,
“bindings”: [
{
“role”: “roles/admin”,
“members”: [
“allUsers”
]
},
]}
How can I check if members contains ‘allUsers’
Admin says
Create XPath expression with help of information given in this xpath example.
sarika says
How can i append two string response from json using jsonpath ?
Ex. JsonResponse
{
“passport”: {
“page_1”: {
“passport_number”: “J8369854”,
“photo”: “https://storage.googleapis.com/dolphin-ekyc-api-v2/2018-11-15-062231656.jpeg”,
“sign”: “https://storage.googleapis.com/dolphin-ekyc-api-v2/2018-11-15-062232aYn.jpeg”,
“surname”: “RAMADUGULA”,
“name”: “SITA MAHA LAKSHMI”,
“nationality”: “INDIAN”,
“sex”: “”,
“date_of_birth”: “23/09/1959”,
“place_of_birth”: “GUNDUGOLANU”,
“date_of_issue”: “11/10/2011”,
“date_of_expiry”: “10/10/2021”
}
}
}
I just want to append name and surname like SITA MAHA LAKSHMI RAMADUGULA
When i tried using $[‘passport’][‘page_1’][‘name’,’surname’] its giving me value :
{
“name” : “SITA MAHA LAKSHMI”,
“surname” : “RAMADUGULA”
}
that i dont want.
Any idea about it ??
Debi says
$.passport.page_1.(name & ‘ ‘ & surname)
Result : “SITA MAHA LAKSHMI RAMADUGULA”