{"id":273,"date":"2018-05-01T10:46:38","date_gmt":"2018-05-01T10:46:38","guid":{"rendered":"https:\/\/restfulapi.net\/?p=273"},"modified":"2021-10-19T14:37:48","modified_gmt":"2021-10-19T09:07:48","slug":"json-jsonpath","status":"publish","type":"post","link":"https:\/\/restfulapi.net\/json-jsonpath\/","title":{"rendered":"JSON with JSONPath"},"content":{"rendered":"\n<p><strong>JSONPath is a query language for <a href=\"https:\/\/restfulapi.net\/introduction-to-json\/\">JSON<\/a><\/strong> with features similar to <a href=\"https:\/\/howtodoinjava.com\/java\/xml\/java-xpath-tutorial-example\/\">XPath<\/a> for XML. JSONPath is used for selecting and extracting a sub-section from the JSON document.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">1. JSONPath Dependencies<\/h2>\n\n\n\n<p>To use JSONPath, we will need to include its dependency and then use it.<\/p>\n\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table class=\"mtr-table mtr-tr-th\"><tbody><tr><th class=\"has-text-align-left mtr-th-tag\" data-align=\"left\" data-mtr-content=\"Language\"><div class=\"mtr-cell-content\">Language<\/div><\/th><th class=\"has-text-align-left mtr-th-tag\" data-align=\"left\" data-mtr-content=\"Dependency\"><div class=\"mtr-cell-content\">Dependency<\/div><\/th><\/tr><tr><td class=\"has-text-align-left mtr-td-tag\" data-align=\"left\" data-mtr-content=\"Language\"><div class=\"mtr-cell-content\">JavaScript<\/div><\/td><td class=\"has-text-align-left mtr-td-tag\" data-align=\"left\" data-mtr-content=\"Dependency\"><div class=\"mtr-cell-content\"><a href=\"https:\/\/storage.googleapis.com\/google-code-archive-downloads\/v2\/code.google.com\/jsonpath\/jsonpath-0.8.0.js.txt\" target=\"_blank\" rel=\"noreferrer noopener\">JSONPath JavaScript File<\/a><\/div><\/td><\/tr><tr><td class=\"has-text-align-left mtr-td-tag\" data-align=\"left\" data-mtr-content=\"Language\"><div class=\"mtr-cell-content\">Node<\/div><\/td><td class=\"has-text-align-left mtr-td-tag\" data-align=\"left\" data-mtr-content=\"Dependency\"><div class=\"mtr-cell-content\"><code>npm install JSONPath<\/code><\/div><\/td><\/tr><tr><td class=\"has-text-align-left mtr-td-tag\" data-align=\"left\" data-mtr-content=\"Language\"><div class=\"mtr-cell-content\">PHP<\/div><\/td><td class=\"has-text-align-left mtr-td-tag\" data-align=\"left\" data-mtr-content=\"Dependency\"><div class=\"mtr-cell-content\"><a href=\"https:\/\/storage.googleapis.com\/google-code-archive-downloads\/v2\/code.google.com\/jsonpath\/jsonpath-0.8.1.php\" target=\"_blank\" rel=\"noreferrer noopener\">JSONPath PHP include file<\/a><\/div><\/td><\/tr><tr><td class=\"has-text-align-left mtr-td-tag\" data-align=\"left\" data-mtr-content=\"Language\"><div class=\"mtr-cell-content\">Python<\/div><\/td><td class=\"has-text-align-left mtr-td-tag\" data-align=\"left\" data-mtr-content=\"Dependency\"><div class=\"mtr-cell-content\"><code>pip install jsonpath-rw<\/code><\/div><\/td><\/tr><tr><td class=\"has-text-align-left mtr-td-tag\" data-align=\"left\" data-mtr-content=\"Language\"><div class=\"mtr-cell-content\">Java<\/div><\/td><td class=\"has-text-align-left mtr-td-tag\" data-align=\"left\" data-mtr-content=\"Dependency\"><div class=\"mtr-cell-content\"><a href=\"https:\/\/mvnrepository.com\/artifact\/com.jayway.jsonpath\/json-path\" target=\"_blank\" rel=\"noreferrer noopener\">json-path<\/a><\/div><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">2. JSONPath Syntax<\/h2>\n\n\n\n<p>A JsonPath expression begins with the dollar sign (<code>$<\/code>) character, which refers to the root element of a query. The dollar sign is followed by a sequence of child elements, which are separated via dot (code) notation or via the square brackets (code).<\/p>\n\n\n\n<p>The important <em>JSONPath syntax rules<\/em> are:<\/p>\n\n\n\n<ul><li><code> $ <\/code> symbol refers to the <strong>root object<\/strong> or element.<\/li><li><code> @ <\/code> symbol refers to the <strong>current object<\/strong> or element.<\/li><li><code> . <\/code> operator is the dot-child operator, which you use to denote a <strong>child element<\/strong> of the current element.<\/li><li><code> [ ] <\/code> is the subscript operator, which you use to denote a <strong>child element of the current element (by name or index)<\/strong>.<\/li><li><code> * <\/code> operator is a wildcard, returning <strong>all objects<\/strong> or elements regardless of their names.<\/li><li><code> , <\/code> operator is the union operator, which returns the <strong>union of the children<\/strong> or indexes indicated.<\/li><li><code> : <\/code> operator is the <strong>array slice operator<\/strong>, so you can slice collections using the syntax <code>[start:end:step]<\/code> to return a subcollection of a collection.<\/li><li><code> ( ) <\/code> operator lets you pass a <strong>script expression<\/strong> in the underlying implementation&#8217;s script language. It&#8217;s not supported by every implementation of JSONPath, however.<\/li><li><code> ? ( )<\/code> to <em>query all items that meet a certain criteria<\/em>.<\/li><\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">3. JSONPath Expression Examples<\/h2>\n\n\n\n<p>Below given are few examples of JSONPath.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">$.store.book[0].title\n$.store.book[*].title\n$..book[3]\n\n\/\/or using brackets\n\n$['store']['book'][0].['title']\n$['store']['book'][*].['title']\n$..['book'][3]\n\n$.store.book[?(@.price &amp;lt; 10)].title<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\">4. JSONPath Example using JavaScript<\/h2>\n\n\n\n<p>We have the following JSON document. We will apply the JSONPath expressions to it.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"json\" class=\"language-json\">{ \n\t\"store\": \n\t{\n\t\t\"book\": [\n\t\t\t{ \n\t\t\t\t\"category\": \"reference\",\n\t\t\t\t\"author\": \"Nigel Rees\",\n\t\t\t\t\"title\": \"Sayings of the Century\",\n\t\t\t\t\"price\": 8.95\n\t\t\t},\n\t\t\t{ \n\t\t\t\t\"category\": \"fiction\",\n\t\t\t\t\"author\": \"Evelyn Waugh\",\n\t\t\t\t\"title\": \"Sword of Honour\",\n\t\t\t\t\"price\": 12.99\n\t\t\t},\n\t\t\t{ \n\t\t\t\t\"category\": \"fiction\",\n\t\t\t\t\"author\": \"Herman Melville\",\n\t\t\t\t\"title\": \"Moby Dick\",\n\t\t\t\t\"isbn\": \"0-553-21311-3\",\n\t\t\t\t\"price\": 8.99\n\t\t\t},\n\t\t\t{ \n\t\t\t\t\"category\": \"fiction\",\n\t\t\t\t\"author\": \"J. R. R. Tolkien\",\n\t\t\t\t\"title\": \"The Lord of the Rings\",\n\t\t\t\t\"isbn\": \"0-395-19395-8\",\n\t\t\t\t\"price\": 22.99\n\t\t\t}\n\t\t],\n\t\t\"bicycle\": {\n\t\t\t\"color\": \"red\",\n\t\t\t\"price\": 19.95\n\t\t}\n\t}\n}<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\">Example 1<\/h4>\n\n\n\n<p>Using JSONPath to find the names of all authors.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"javascript\" class=\"language-javascript\">var response = jsonPath(store , \"$..author\").toJSONString();<\/code><\/pre>\n\n\n\n<p>Program output:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"json\" class=\"language-json\">[\n\"Nigel Rees\",\n\"Evelyn Waugh\",\n\"Herman Melville\",\n\"J. R. R. Tolkien\"\n]<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\">Example 2<\/h4>\n\n\n\n<p>Using JSONPath to find the details for book number 4. The array index is zero-based.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"javascript\" class=\"language-javascript\">var response = jsonPath(store , \"$..book[3]\").toJSONString();<\/code><\/pre>\n\n\n\n<p>Program output:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"json\" class=\"language-json\">[\n\t{\n\t\t\"category\":\"fiction\",\n\t\t\"author\":\"J. R. R. Tolkien\",\n\t\t\"title\":\"The Lord of the Rings\",\n\t\t\"isbn\":\"0-395-19395-8\",\n\t\t\"price\":22.99\n\t}\n]<\/code><\/pre>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>JSONPath is a query language for JSON with features similar to XPath for XML. JSONPath is used for selecting and extracting a sub-section from the JSON document. 1. JSONPath Dependencies To use JSONPath, we will need to include its dependency and then use it. Language Dependency JavaScript JSONPath JavaScript File Node npm install JSONPath PHP &#8230; <a title=\"JSON with JSONPath\" class=\"read-more\" href=\"https:\/\/restfulapi.net\/json-jsonpath\/\" aria-label=\"More on JSON with JSONPath\">Read more<\/a><\/p>\n","protected":false},"author":1,"featured_media":249,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[16],"tags":[17,22],"_links":{"self":[{"href":"https:\/\/restfulapi.net\/wp-json\/wp\/v2\/posts\/273"}],"collection":[{"href":"https:\/\/restfulapi.net\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/restfulapi.net\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/restfulapi.net\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/restfulapi.net\/wp-json\/wp\/v2\/comments?post=273"}],"version-history":[{"count":0,"href":"https:\/\/restfulapi.net\/wp-json\/wp\/v2\/posts\/273\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/restfulapi.net\/wp-json\/wp\/v2\/media\/249"}],"wp:attachment":[{"href":"https:\/\/restfulapi.net\/wp-json\/wp\/v2\/media?parent=273"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/restfulapi.net\/wp-json\/wp\/v2\/categories?post=273"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/restfulapi.net\/wp-json\/wp\/v2\/tags?post=273"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}