Interface WebTestClient.BodyContentSpec
- Enclosing interface:
- WebTestClient
public static interface WebTestClient.BodyContentSpec
Spec for expectations on the response body content.
-
Method Summary
Modifier and TypeMethodDescriptionconsumeWith
(Consumer<EntityExchangeResult<byte[]>> consumer) Assert the response body content with the givenConsumer
.isEmpty()
Assert the response body is empty and return the exchange result.default WebTestClient.BodyContentSpec
Parse the expected and actual response content as JSON and perform a comparison verifying that they contain the same attribute-value pairs regardless of formatting with lenient checking (extensible and non-strict array ordering).Parse the expected and actual response content as JSON and perform a comparison verifying that they contain the same attribute-value pairs regardless of formatting.Access to response body assertions using a JsonPath expression to inspect a specific subset of the body.EntityExchangeResult<byte[]>
Exit the chained API and return anExchangeResult
with the raw response content.Parse expected and actual response content as XML and assert that the two are "similar", i.e.default XpathAssertions
Access to response body assertions using an XPath expression to inspect a specific subset of the body.Access to response body assertions with specific namespaces using an XPath expression to inspect a specific subset of the body.
-
Method Details
-
isEmpty
EntityExchangeResult<Void> isEmpty()Assert the response body is empty and return the exchange result. -
json
Parse the expected and actual response content as JSON and perform a comparison verifying that they contain the same attribute-value pairs regardless of formatting with lenient checking (extensible and non-strict array ordering).Use of this method requires the JSONassert library to be on the classpath.
- Parameters:
expectedJson
- the expected JSON content- See Also:
-
json
Parse the expected and actual response content as JSON and perform a comparison verifying that they contain the same attribute-value pairs regardless of formatting.Can compare in two modes, depending on the
strict
parameter value:true
: strict checking. Not extensible and strict array ordering.false
: lenient checking. Extensible and non-strict array ordering.
Use of this method requires the JSONassert library to be on the classpath.
- Parameters:
expectedJson
- the expected JSON contentstrict
- enables strict checking iftrue
- Since:
- 5.3.16
- See Also:
-
xml
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:
-
jsonPath
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
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
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
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.
-