public final class MockRestServiceServer
extends java.lang.Object
RestTemplate
を直接または間接的に使用するテストに使用します。RestTemplate
を介して実行される予想されるリクエストと、返送するモックレスポンスを設定する方法を提供するため、実際のサーバーの必要性がなくなります。 以下は、MockRestRequestMatchers
、MockRestResponseCreators
、ExpectedCount
からの静的インポートを想定した例です。
RestTemplate restTemplate = new RestTemplate() MockRestServiceServer server = MockRestServiceServer.bindTo(restTemplate).build(); server.expect(manyTimes(), requestTo("/hotels/42")).andExpect(method(HttpMethod.GET)) .andRespond(withSuccess("{ \"id\" : \"42\", \"name\" : \"Holiday Inn\"}", MediaType.APPLICATION_JSON)); Hotel hotel = restTemplate.getForObject("/hotels/{id}", Hotel.class, 42); // Use the hotel instance... // Verify all expectations met server.verify();
上記の代わりに、MockMvc
のインスタンスに対してリクエストを実行できるようにする RestTemplate
に MockMvcClientHttpRequestFactory
を設定することもできます。
修飾子と型 | クラスと説明 |
---|---|
static interface | MockRestServiceServer.MockRestServiceServerBuilder MockRestServiceServer を作成するビルダー。 |
修飾子と型 | メソッドと説明 |
---|---|
static MockRestServiceServer.MockRestServiceServerBuilder | bindTo(AsyncRestTemplate asyncRestTemplate) 使用すべきではありません。 AsyncRestTemplate 自体の非推奨通知を参照してください |
static MockRestServiceServer.MockRestServiceServerBuilder | bindTo(RestGatewaySupport restGateway) 指定された RestGatewaySupport に応答するために使用する必要がある MockRestServiceServer のビルダーを返します。 |
static MockRestServiceServer.MockRestServiceServerBuilder | bindTo(RestTemplate restTemplate) 指定された RestTemplate に応答するために使用する必要がある MockRestServiceServer のビルダーを返します。 |
static MockRestServiceServer | createServer(AsyncRestTemplate asyncRestTemplate) 使用すべきではありません。 AsyncRestTemplate 自体の非推奨通知を参照してください |
static MockRestServiceServer | createServer(RestGatewaySupport restGateway) bindTo(restGateway).build() のショートカット。 |
static MockRestServiceServer | createServer(RestTemplate restTemplate) bindTo(restTemplate).build() のショートカット。 |
ResponseActions | expect(ExpectedCount count, RequestMatcher matcher) リクエストの実行が予想される回数も示す expect(RequestMatcher) の代替。 |
ResponseActions | expect(RequestMatcher matcher) 単一の HTTP リクエストに対する期待を設定します。 |
void | reset() すべての期待値と記録されたリクエストを削除して内部状態をリセットします。 |
void | verify() expect(RequestMatcher) を介して設定されたすべての予想されるリクエストが実際に実行されたことを確認します。 |
public ResponseActions expect(RequestMatcher matcher)
ResponseActions
を使用して、さらに期待を設定し、レスポンスを定義できます。 このメソッドは、予想されるすべてのリクエストをセットアップするために、基礎となる RestTemplate
を介してリクエストを開始する前に何度でも呼び出すことができます。
matcher
- リクエストマッチャー public ResponseActions expect(ExpectedCount count, RequestMatcher matcher)
expect(RequestMatcher)
の代替。リクエストの期待値が 1 よりも大きい場合、最初の実行のみが宣言の順序と一致することが期待されます。後続のリクエスト実行は、その後どこにでも挿入できます。
count
- 予想される数 matcher
- リクエストマッチャー public void verify()
expect(RequestMatcher)
を介して設定されたすべての予想されるリクエストが実際に実行されたことを確認します。java.lang.AssertionError
- 期待に応えられなかったとき public void reset()
public static MockRestServiceServer.MockRestServiceServerBuilder bindTo(RestTemplate restTemplate)
RestTemplate
に応答するために使用する必要がある MockRestServiceServer
のビルダーを返します。@Deprecated public static MockRestServiceServer.MockRestServiceServerBuilder bindTo(AsyncRestTemplate asyncRestTemplate)
AsyncRestTemplate
に応答するために使用する必要がある MockRestServiceServer
のビルダーを返します。public static MockRestServiceServer.MockRestServiceServerBuilder bindTo(RestGatewaySupport restGateway)
RestGatewaySupport
に応答するために使用する必要がある MockRestServiceServer
のビルダーを返します。public static MockRestServiceServer createServer(RestTemplate restTemplate)
bindTo(restTemplate).build()
のショートカット。restTemplate
- RestTemplate でモックテストをセットアップする @Deprecated public static MockRestServiceServer createServer(AsyncRestTemplate asyncRestTemplate)
bindTo(asyncRestTemplate).build()
のショートカット。asyncRestTemplate
- AsyncRestTemplate でモックテストをセットアップする public static MockRestServiceServer createServer(RestGatewaySupport restGateway)
bindTo(restGateway).build()
のショートカット。restGateway
- モックテスト用にセットアップする REST ゲートウェイ