https://github.com/valid4j/json-path-matchers

Matchers to test your JSON using json path expressions (based on jayway.jsonpath)
https://github.com/valid4j/json-path-matchers

Last synced: 3 months ago
JSON representation

Matchers to test your JSON using json path expressions (based on jayway.jsonpath)

• Host: GitHub
• URL: https://github.com/valid4j/json-path-matchers
• Owner: valid4j
• License: apache-2.0
• Created: 2016-01-30T16:10:47.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2021-04-26T16:19:42.000Z (almost 5 years ago)
• Last Synced: 2025-07-21T07:48:16.445Z (9 months ago)
• Language: Java
• Size: 20.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
json-path-matchers

==================

A library with [hamcrest-matchers](http://hamcrest.org/JavaHamcrest/) for testing JSON

using json path expressions, based on [JsonPath](https://github.com/jayway/JsonPath).

# Getting started

This library is available at [Maven Central Repository](http://search.maven.org/).

Add this dependency to your `pom.xml`

    

	    org.valid4j

	    json-path-matchers

	    1.1

    

Correlation between different artifacts (i.e. compile dependency):

| org.valid4j:json-path-matchers  | com.jayway.jsonpath:json-path |

| ------------- | ------------- |

| 1.1  | 2.1.0  |

| 1.0  | 2.0.0  |

# Usage guide

Statically import the library entry point:

    import static org.valid4j.matchers.jsonpath.JsonPathMatchers.*;

NOTE: The actual evaluation of JsonPath will depend on the current configuration:

    Configuration.setDefaults(...);

The matchers can be used to inspect different representations of JSON:

    // As a String...

    String json = ...;

    

    // or a file...

    File json = ...;

    

    // or an already parsed json object...

    Object json = Configuration.defaultConfiguration().jsonProvider().parse(content);

    

Usage examples:

    

    // Verify validity of JSON

    assertThat(json, isJson());

    // Verify existence (or non-existence) of JSON path

    assertThat(json, hasJsonPath("$.message"));

    assertThat(json, hasNoJsonPath("$.message"));

    // Verify evaluation of JSON path

    assertThat(json, hasJsonPath("$.message", equalTo("Hi there")));

    assertThat(json, hasJsonPath("$.quantity", equalTo(5)));

    assertThat(json, hasJsonPath("$.price", equalTo(34.56)));

    assertThat(json, hasJsonPath("$.store.book[*].author", hasSize(4)));

    assertThat(json, hasJsonPath("$.store.book[*].author", hasItem("Evelyn Waugh")));

Combine matchers for greater expressiveness

    

    // This will separate the JSON parsing from the path evaluation

    assertThat(json, isJson(withoutJsonPath("...")));

    assertThat(json, isJson(withJsonPath("...", equalTo(3))));    

    

    // Combine several JSON path evaluations into a single statement

    // (This will parse the JSON only once)

    assertThat(json, isJson(allOf(

        withJsonPath("$.store.name", equalTo("Little Shop")),

        withoutJsonPath("$.expensive"),

        withJsonPath("$..title", hasSize(4)))));

Match on pre-compiled complex JSON path expressions

    Filter cheapFictionFilter = filter(

        where("category").is("fiction").and("price").lte(10D));

    JsonPath cheapFiction = JsonPath.compile("$.store.book[?]", cheapFictionFilter);

    String json = ...;

    assertThat(json, isJson(withJsonPath(cheapFiction)));

        

Use typed matchers for specific JSON representations, if needed

    String json = ...

    assertThat(json, isJsonString(withJsonPath("$..author")));

    File json = ...

    assertThat(json, isJsonFile(withJsonPath("$..author")));

## Project license

This software is licensed under [Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)