Class MockServerRestClientCustomizer

java.lang.Object
org.springframework.boot.test.web.client.MockServerRestClientCustomizer
All Implemented Interfaces:
RestClientCustomizer

public class MockServerRestClientCustomizer extends Object implements RestClientCustomizer
RestClientCustomizer that can be applied to RestClient.Builder instances to add MockRestServiceServer support.

Typically applied to an existing builder before it is used, for example:

 MockServerRestClientCustomizer customizer = new MockServerRestClientCustomizer();
 RestClient.Builder builder = RestClient.builder();
 customizer.customize(builder);
 MyBean bean = new MyBean(client.build());
 customizer.getServer().expect(requestTo("/hello")).andRespond(withSuccess());
 bean.makeRestCall();
 

If the customizer is only used once, the getServer() method can be used to obtain the mock server. If the customizer has been used more than once the getServer(RestClient.Builder) or getServers() method must be used to access the related server.

If a mock server is used in more than one test case in a test class, it might be necessary to reset the expectations on the server between tests using getServer().reset() or getServer(restClientBuilder).reset().

Since:
3.2.0
Author:
Scott Frederick
See Also: