Add basic support for using bracket notation in JSON field paths

Previously, only dot notation JSON field paths were supported. Using
dot notation, each key is separated by a '.'. This makes it impossible
to reference a field where the key itself contains a dot.

This commit adds basic bracket notation support to JsonFieldPath.
With this commit, existing functionality remains as is, but users can
now use a basic form of JsonPath bracket notation. This enables the
use of Json keys with embedded dots. i.e. something like :

{
	"a.b" : "one"
}

.andDo(document("example",responseFields(fieldWithPath("['a.b']")…

Closes gh-132
This commit is contained in:
“Jeremy
2015-09-21 20:57:20 -06:00
committed by Andy Wilkinson
parent 5cd25897ce
commit f3b83f977e
3 changed files with 68 additions and 20 deletions

View File

@@ -92,8 +92,10 @@ must be compatible with `application/xml`.
[[documenting-your-api-request-response-payloads-json-field-paths]]
===== JSON field paths
JSON field paths use `.` to descend into a child object and `[]` to identify an array. For
example, with this JSON payload:
JSON field paths use `.` or bracket notation to descend into a child object and `[]` to
identify an array. Using bracket notation enables the use of `.` within a key name.
For example, with this JSON payload:
[source,json,indent=0]
----
@@ -109,7 +111,8 @@ example, with this JSON payload:
{
"d":"three"
}
]
],
"e.dot" : "four"
}
}
----
@@ -126,6 +129,15 @@ The following paths are all present:
|`a.b`
|An array containing three objects
|`['a']['b']`
|An array containing three objects
|`a['b']`
|An array containing three objects
|`['a'].b`
|An array containing three objects
|`a.b[]`
|An array containing three objects
@@ -134,6 +146,14 @@ The following paths are all present:
|`a.b[].d`
|The string `three`
|`a['e.dot']`
|The string `four`
|`['a']['e.dot']`
|The string `four`
|===