类 JsonPathRequestMatchers
- java.lang.Object
- org.springframework.test.web.client.match.JsonPathRequestMatchers
public class JsonPathRequestMatchers extends Object
Factory for assertions on the request content using JsonPath expressions.An instance of this class is typically accessed via
MockRestRequestMatchers.jsonPath(String, Matcher)
orMockRestRequestMatchers.jsonPath(String, Object...)
.- 从以下版本开始:
- 3.2
- 作者:
- Rossen Stoyanchev, Sam Brannen
构造器概要
构造器 限定符 构造器 说明 protected
JsonPathRequestMatchers(String expression, Object... args)
Protected constructor.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 RequestMatcher
doesNotExist()
Evaluate the JSON path expression against the request content and assert that a value does not exist at the given path.RequestMatcher
exists()
Evaluate the JSON path expression against the request content and assert that a non-null value exists at the given path.RequestMatcher
isArray()
Evaluate the JSON path expression against the request content and assert that the result is an array.RequestMatcher
isBoolean()
Evaluate the JSON path expression against the request content and assert that the result is aBoolean
.RequestMatcher
isEmpty()
Evaluate the JSON path expression against the request content and assert that an empty value exists at the given path.RequestMatcher
isMap()
Evaluate the JSON path expression against the request content and assert that the result is aMap
.RequestMatcher
isNotEmpty()
Evaluate the JSON path expression against the request content and assert that a non-empty value exists at the given path.RequestMatcher
isNumber()
Evaluate the JSON path expression against the request content and assert that the result is aNumber
.RequestMatcher
isString()
Evaluate the JSON path expression against the request content and assert that the result is aString
.RequestMatcher
value(Object expectedValue)
Evaluate the JSON path expression against the request content and assert that the result is equal to the supplied value.<T> RequestMatcher
value(Matcher<T> matcher)
Evaluate the JSON path expression against the request content and assert the resulting value with the given HamcrestMatcher
.<T> RequestMatcher
value(Matcher<T> matcher, Class<T> targetType)
An overloaded variant ofvalue(Matcher)
that also accepts a target type for the resulting value that the matcher can work reliably against.
构造器详细资料
JsonPathRequestMatchers
protected JsonPathRequestMatchers(String expression, Object... args)
Protected constructor.Use
MockRestRequestMatchers.jsonPath(String, Matcher)
orMockRestRequestMatchers.jsonPath(String, Object...)
.- 参数:
expression
- theJsonPath
expression; nevernull
or emptyargs
- arguments to parameterize theJsonPath
expression with, using formatting specifiers defined inString.format(String, Object...)
方法详细资料
value
public <T> RequestMatcher value(Matcher<T> matcher)
Evaluate the JSON path expression against the request content and assert the resulting value with the given HamcrestMatcher
.
value
public <T> RequestMatcher value(Matcher<T> matcher, Class<T> targetType)
An overloaded variant ofvalue(Matcher)
that also accepts a target type for the resulting value that the matcher can work reliably against.This can be useful for matching numbers reliably — for example, to coerce an integer into a double.
- 从以下版本开始:
- 4.3.3
value
public RequestMatcher value(Object expectedValue)
Evaluate the JSON path expression against the request content and assert that the result is equal to the supplied value.
exists
public RequestMatcher exists()
Evaluate the JSON path expression against the request content and assert that a non-null value exists at the given path.If the JSON path expression is not definite, this method asserts that the value at the given path is not empty.
doesNotExist
public RequestMatcher doesNotExist()
Evaluate the JSON path expression against the request content and assert that a value does not exist at the given path.If the JSON path expression is not definite, this method asserts that the value at the given path is empty.
isEmpty
public RequestMatcher isEmpty()
Evaluate the JSON path expression against the request content and assert that an empty value exists at the given path.For the semantics of empty, consult the Javadoc for
ObjectUtils.isEmpty(Object)
.- 从以下版本开始:
- 4.2.1
- 另请参阅:
isNotEmpty()
,exists()
,doesNotExist()
isNotEmpty
public RequestMatcher isNotEmpty()
Evaluate the JSON path expression against the request content and assert that a non-empty value exists at the given path.For the semantics of empty, consult the Javadoc for
ObjectUtils.isEmpty(Object)
.- 从以下版本开始:
- 4.2.1
- 另请参阅:
isEmpty()
,exists()
,doesNotExist()
isString
public RequestMatcher isString()
Evaluate the JSON path expression against the request content and assert that the result is aString
.- 从以下版本开始:
- 4.2.1
isBoolean
public RequestMatcher isBoolean()
Evaluate the JSON path expression against the request content and assert that the result is aBoolean
.- 从以下版本开始:
- 4.2.1
isNumber
public RequestMatcher isNumber()
Evaluate the JSON path expression against the request content and assert that the result is aNumber
.- 从以下版本开始:
- 4.2.1
isArray
public RequestMatcher isArray()
Evaluate the JSON path expression against the request content and assert that the result is an array.
isMap
public RequestMatcher isMap()
Evaluate the JSON path expression against the request content and assert that the result is aMap
.- 从以下版本开始:
- 4.2.1