josephpconley / play-jsonpath

JSONPath library to complement Play's json library

GitHub

JSONPath library for Play

Join the chat at https://gitter.im/josephpconley/play-jsonpath

This library enables JSONPath queries on the Play JsValue.

Explanation of JSONPath can be found here: http://goessner.net/articles/JsonPath/

Releases

Here are the versions of this plugin compatible with the Play JSON library

Plugin version Play version Scala version
2.6.0 2.6.x 2.11.x
2.5.0 2.5.x 2.11.x
2.4.0 2.4.x [2.10.x, 2.11.x]
2.3.0 [2.2.x, 2.3.x] [2.10.x, 2.11.x]

Install

libraryDependencies += "com.josephpconley" %% "play-jsonpath" % "2.4.0"

Example Usage

val json = Json.parse("""
{
 "id": 1,
 "name": "Joe",
 "tags": ["programmer", "husband", "father", "golfer"],
 "address": [
    {"id": 2, "street": "123 Main St.", "city": "Springfield", "state": "PA"},
    {"id": 3, "street": "456 Main St.", "city": "Sea Isle City", "state": "NJ", "beach": true}
 ]
}
"""

import com.josephpconley.jsonpath.JSONPath

JSONPath.query("$.id", json)                    //JsNumber(1)
JSONPath.query("$..id", json)                   //JsArray(JsNumber(1), JsNumber(2), JsNumber(3))
JSONPath.query("$.address[*].city", json)       //JsArray(JsString("Springfield"), JsString("Sea Isle City"))
JSONPath.query("$.address[?(@.beach)]", json)   //JsArray(JsObject(Seq("id" -> JsNumber(3), "street" -> JsString("456 Main St."), "city" -> JsString("Sea Isle City"), "state" -> JsString("NJ"), "beach" -> JsBoolean(true)))

Blog post

You can read more about the library here