类 MockRestRequestMatchers
- java.lang.Object
- org.springframework.test.web.client.match.MockRestRequestMatchers
public abstract class MockRestRequestMatchers extends Object
Static factory methods forRequestMatcher
classes. Typically used to provide input forMockRestServiceServer.expect(RequestMatcher)
.Eclipse Users
Consider adding this class as a Java editor favorite. To navigate to this setting, open the Preferences and type "favorites".
- 从以下版本开始:
- 3.2
- 作者:
- Craig Walls, Rossen Stoyanchev, Sam Brannen
构造器概要
构造器 构造器 说明 MockRestRequestMatchers()
方法概要
所有方法 静态方法 具体方法 修饰符和类型 方法 说明 static RequestMatcher
anything()
Match to any request.static ContentRequestMatchers
content()
Access to request body matchers.static RequestMatcher
header(String name, String... expectedValues)
Assert request header values.static RequestMatcher
header(String name, Matcher<? super String>... matchers)
Assert request header values with the given Hamcrest matcher(s).static RequestMatcher
headerDoesNotExist(String name)
Assert that the given request header does not exist.static JsonPathRequestMatchers
jsonPath(String expression, Object... args)
Access to request body matchers using a JsonPath expression to inspect a specific subset of the body.static <T> RequestMatcher
jsonPath(String expression, Matcher<T> matcher)
Access to request body matchers using a JsonPath expression to inspect a specific subset of the body and a Hamcrest match for asserting the value found at the JSON path.static RequestMatcher
method(HttpMethod method)
Assert theHttpMethod
of the request.static RequestMatcher
queryParam(String name, String... expectedValues)
Assert request query parameter values.static RequestMatcher
queryParam(String name, Matcher<? super String>... matchers)
Assert request query parameter values with the given Hamcrest matcher(s).static RequestMatcher
requestTo(String expectedUri)
Assert the request URI matches the given string.static RequestMatcher
requestTo(URI uri)
Expect a request to the given URI.static RequestMatcher
requestTo(Matcher<String> matcher)
Assert the request URI string with the given Hamcrest matcher.static RequestMatcher
requestToUriTemplate(String expectedUri, Object... uriVars)
Variant ofrequestTo(URI)
that prepares the URI from a URI template plus optional variables viaUriComponentsBuilder
including encoding.static XpathRequestMatchers
xpath(String expression, Object... args)
Access to request body matchers using an XPath to inspect a specific subset of the body.static XpathRequestMatchers
xpath(String expression, Map<String,String> namespaces, Object... args)
Access to response body matchers using an XPath to inspect a specific subset of the body.
构造器详细资料
MockRestRequestMatchers
public MockRestRequestMatchers()
方法详细资料
anything
public static RequestMatcher anything()
Match to any request.
method
public static RequestMatcher method(HttpMethod method)
Assert theHttpMethod
of the request.- 参数:
method
- the HTTP method- 返回:
- the request matcher
requestTo
public static RequestMatcher requestTo(Matcher<String> matcher)
Assert the request URI string with the given Hamcrest matcher.- 参数:
matcher
- the String matcher for the expected URI- 返回:
- the request matcher
requestTo
public static RequestMatcher requestTo(String expectedUri)
Assert the request URI matches the given string.- 参数:
expectedUri
- the expected URI- 返回:
- the request matcher
requestToUriTemplate
public static RequestMatcher requestToUriTemplate(String expectedUri, Object... uriVars)
Variant ofrequestTo(URI)
that prepares the URI from a URI template plus optional variables viaUriComponentsBuilder
including encoding.- 参数:
expectedUri
- the expected URI templateuriVars
- zero or more URI variables to populate the expected URI- 返回:
- the request matcher
requestTo
public static RequestMatcher requestTo(URI uri)
Expect a request to the given URI.- 参数:
uri
- the expected URI- 返回:
- the request matcher
queryParam
@SafeVarargs public static RequestMatcher queryParam(String name, Matcher<? super String>... matchers)
Assert request query parameter values with the given Hamcrest matcher(s).
queryParam
public static RequestMatcher queryParam(String name, String... expectedValues)
Assert request query parameter values.
header
@SafeVarargs public static RequestMatcher header(String name, Matcher<? super String>... matchers)
Assert request header values with the given Hamcrest matcher(s).
header
public static RequestMatcher header(String name, String... expectedValues)
Assert request header values.
headerDoesNotExist
public static RequestMatcher headerDoesNotExist(String name)
Assert that the given request header does not exist.- 从以下版本开始:
- 5.2
content
public static ContentRequestMatchers content()
Access to request body matchers.
jsonPath
public static JsonPathRequestMatchers jsonPath(String expression, Object... args)
Access to request body matchers 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 inString.format(String, Object...)
.- 参数:
expression
- the JSON path optionally parameterized with argumentsargs
- arguments to parameterize the JSON path expression with
jsonPath
public static <T> RequestMatcher jsonPath(String expression, Matcher<T> matcher)
Access to request body matchers using a JsonPath expression to inspect a specific subset of the body and a Hamcrest match for asserting the value found at the JSON path.- 参数:
expression
- the JSON path expressionmatcher
- a matcher for the value expected at the JSON path
xpath
public static XpathRequestMatchers xpath(String expression, Object... args) throws XPathExpressionException
Access to request body matchers using an XPath to inspect a specific subset of the body. The XPath expression can be a parameterized string using formatting specifiers as defined inString.format(String, Object...)
.- 参数:
expression
- the XPath optionally parameterized with argumentsargs
- arguments to parameterize the XPath expression with- 抛出:
XPathExpressionException
xpath
public static XpathRequestMatchers xpath(String expression, Map<String,String> namespaces, Object... args) throws XPathExpressionException
Access to response body matchers using an XPath to inspect a specific subset of the body. The XPath expression can be a parameterized string using formatting specifiers as defined inString.format(String, Object...)
.- 参数:
expression
- the XPath optionally parameterized with argumentsnamespaces
- the namespaces referenced in the XPath expressionargs
- arguments to parameterize the XPath expression with- 抛出:
XPathExpressionException