assertj-json/README.md

AssertJ - fluent assertions for json

This library provides helper methods for asserting JSON strings with AssertJ.

To include it with Maven

<dependency>
    <groupId>com.devsoap</groupId>
    <artifactId>assertj-json</artifactId>
    <version>0.0.2</version>
    <classifier>tests</classifier>
    <scope>test</scope>
</dependency>

And with Gradle

testImplementation 'com.devsoap:assertj-json:0.0.2'

Syntax Examples:

// Assert that a root property is equal to a string
JsonAssert.assertThat(JSON).field("myprop").isEqualTo("foo");

// Assert that the traversed path exists and the property is larger than two
JsonAssert.assertThat(JSON).path("a", "b", "c").isEqualTo(2);
// OR
JsonAssert.assertThat(JSON).field("a").field("b").field("c").isEqualTo(2);

// Cast property before asserting
JsonAssert.assertThat(JSON).field("bigdecimal").asBigDecimal().isEqualTo(BigDecimal.valueOf(1234.0));

// Match by regular expression (myprop:"foobar")
JsonAssert.assertThat(JSON).field("myprop").matches("foo.*")
    
// Assert first property in Object matches
JsonAssert.assertThat(JSON).firstField("lastProp").isEqualTo(1);

// Assert last property in Object matches
JsonAssert.assertThat(JSON).lastField("lastProp").isEqualTo(3);

// Assert nth property in Object matches
JsonAssert.assertThat(JSON).nthField("secondProp").isEqualTo(2);

// Assert root typed array "[1,2,3]"
JsonAssert.assertThat(JSON).asArray(Integer.class).first().isEqualTo(1);

// Assert root array with objects "[{ prop: 1}]"
JsonAssert.assertThat(JSON).asArray().first().field("prop").isEqualTo(1);

// Assert matrix [[1,2],[3,4]]
assertThat(JSON).asArray().last().asArray().first().asInteger().isEqualTo(3);

For more examples see the unit tests in unit tests.

Licensed under CC BY-ND 4.0.