Interface WebTestClient.BodyContentSpec
- Enclosing interface:
- WebTestClient
public static interface WebTestClient.BodyContentSpec
Spec for expectations on the response body content.
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description WebTestClient.BodyContentSpec
consumeWith(Consumer<EntityExchangeResult<byte[]>> consumer)
Assert the response body content with the givenConsumer
.EntityExchangeResult<Void>
isEmpty()
Assert the response body is empty and return the exchange result.WebTestClient.BodyContentSpec
json(String expectedJson)
Parse the expected and actual response content as JSON and perform a "lenient" comparison verifying the same attribute-value pairs.JsonPathAssertions
jsonPath(String expression, Object... args)
Access to response body assertions using a JsonPath expression to inspect a specific subset of the body.EntityExchangeResult<byte[]>
returnResult()
Exit the chained API and return anExchangeResult
with the raw response content.WebTestClient.BodyContentSpec
xml(String expectedXml)
Parse expected and actual response content as XML and assert that the two are "similar", i.e.default XpathAssertions
xpath(String expression, Object... args)
Access to response body assertions using an XPath expression to inspect a specific subset of the body.XpathAssertions
xpath(String expression, Map<String,String> namespaces, Object... args)
Access to response body assertions with specific namespaces using an XPath expression to inspect a specific subset of the body.
Method Detail
isEmpty
EntityExchangeResult<Void> isEmpty()
Assert the response body is empty and return the exchange result.
json
WebTestClient.BodyContentSpec json(String expectedJson)
Parse the expected and actual response content as JSON and perform a "lenient" comparison verifying the same attribute-value pairs.Use of this option requires the JSONassert library on to be on the classpath.
- Parameters:
expectedJson
- the expected JSON content.
xml
WebTestClient.BodyContentSpec xml(String expectedXml)
Parse expected and actual response content as XML and assert that the two are "similar", i.e. they contain the same elements and attributes regardless of order.Use of this method requires the XMLUnit library on the classpath.
- Parameters:
expectedXml
- the expected JSON content.- Since:
- 5.1
- See Also:
XmlExpectationsHelper.assertXmlEqual(String, String)
jsonPath
JsonPathAssertions jsonPath(String expression, Object... args)
Access to response body assertions using a JsonPath expression to inspect a specific subset of the body.The JSON path expression can be a parameterized string using formatting specifiers as defined in
String.format(java.lang.String, java.lang.Object...)
.- Parameters:
expression
- the JsonPath expressionargs
- arguments to parameterize the expression
xpath
default XpathAssertions xpath(String expression, Object... args)
Access to response body assertions using an XPath expression to inspect a specific subset of the body.The XPath expression can be a parameterized string using formatting specifiers as defined in
String.format(java.lang.String, java.lang.Object...)
.- Parameters:
expression
- the XPath expressionargs
- arguments to parameterize the expression- Since:
- 5.1
- See Also:
xpath(String, Map, Object...)
xpath
XpathAssertions xpath(String expression, @Nullable Map<String,String> namespaces, Object... args)
Access to response body assertions with specific namespaces using an XPath expression to inspect a specific subset of the body.The XPath expression can be a parameterized string using formatting specifiers as defined in
String.format(java.lang.String, java.lang.Object...)
.- Parameters:
expression
- the XPath expressionnamespaces
- the namespaces to useargs
- arguments to parameterize the expression- Since:
- 5.1
consumeWith
WebTestClient.BodyContentSpec consumeWith(Consumer<EntityExchangeResult<byte[]>> consumer)
Assert the response body content with the givenConsumer
.- Parameters:
consumer
- the consumer for the response body; the inputbyte[]
may benull
if there was no response body.
returnResult
EntityExchangeResult<byte[]> returnResult()
Exit the chained API and return anExchangeResult
with the raw response content.