spring-boot-test/org.springframework.boot.test.web.client

Package-level declarations

Web client test utilities.

Types

LocalHostUriTemplateHandler

open class LocalHostUriTemplateHandler : RootUriTemplateHandler

UriTemplateHandler will automatically prefix relative URIs with localhost:${local.server.port}.

MockServerRestClientCustomizer

open class MockServerRestClientCustomizer : RestClientCustomizer

RestClientCustomizer that can be applied to RestClient.Builder instances to add MockRestServiceServer support.

MockServerRestTemplateCustomizer

open class MockServerRestTemplateCustomizer : RestTemplateCustomizer

RestTemplateCustomizer that can be applied to a RestTemplateBuilder instances to add MockRestServiceServer support.

RootUriRequestExpectationManager

open class RootUriRequestExpectationManager : RequestExpectationManager

RequestExpectationManager that strips the specified root URI from the request before verification.

TestRestTemplate

open class TestRestTemplate

Convenient alternative of RestTemplate that is suitable for integration tests.

Functions

exchange

inline fun <T : Any> TestRestTemplate.exchange(requestEntity: RequestEntity<*>): ResponseEntity<T>

inline fun <T : Any> TestRestTemplate.exchange(url: URI, method: HttpMethod, requestEntity: HttpEntity<*>? = null): ResponseEntity<T>

inline fun <T : Any> TestRestTemplate.exchange(url: String, method: HttpMethod, requestEntity: HttpEntity<*>? = null, vararg uriVariables: Any): ResponseEntity<T>

inline fun <T : Any> TestRestTemplate.exchange(url: String, method: HttpMethod, requestEntity: HttpEntity<*>? = null, uriVariables: Map<String, *>): ResponseEntity<T>

Extension for TestRestTemplate.exchange providing an exchange<Foo>(...) variant leveraging Kotlin reified type parameters. This extension is not subject to type erasure and retains actual generic type arguments.

getForEntity

inline fun <T : Any> TestRestTemplate.getForEntity(url: URI): ResponseEntity<T>

inline fun <T : Any> TestRestTemplate.getForEntity(url: String, vararg uriVariables: Any): ResponseEntity<T>

inline fun <T : Any> TestRestTemplate.getForEntity(url: String, uriVariables: Map<String, *>): ResponseEntity<T>

Extension for TestRestTemplate.getForEntity providing a getForEntity<Foo>(...) variant leveraging Kotlin reified type parameters. Like the original Java method, this extension is subject to type erasure. Use exchange if you need to retain actual generic type arguments.

getForObject

inline fun <T : Any> TestRestTemplate.getForObject(url: URI): T?

inline fun <T : Any> TestRestTemplate.getForObject(url: String, vararg uriVariables: Any): T?

inline fun <T : Any> TestRestTemplate.getForObject(url: String, uriVariables: Map<String, Any?>): T?

Extension for TestRestTemplate.getForObject providing a getForObject<Foo>(...) variant leveraging Kotlin reified type parameters. Like the original Java method, this extension is subject to type erasure. Use exchange if you need to retain actual generic type arguments.

patchForObject

inline fun <T : Any> TestRestTemplate.patchForObject(url: URI, request: Any? = null): T?

inline fun <T : Any> TestRestTemplate.patchForObject(url: String, request: Any? = null, vararg uriVariables: Any): T?

inline fun <T : Any> TestRestTemplate.patchForObject(url: String, request: Any? = null, uriVariables: Map<String, *>): T?

Extension for TestRestTemplate.patchForObject providing a patchForObject<Foo>(...) variant leveraging Kotlin reified type parameters. Like the original Java method, this extension is subject to type erasure. Use exchange if you need to retain actual generic type arguments.

postForEntity

inline fun <T : Any> TestRestTemplate.postForEntity(url: URI, request: Any? = null): ResponseEntity<T>

inline fun <T : Any> TestRestTemplate.postForEntity(url: String, request: Any? = null, vararg uriVariables: Any): ResponseEntity<T>

inline fun <T : Any> TestRestTemplate.postForEntity(url: String, request: Any? = null, uriVariables: Map<String, *>): ResponseEntity<T>

Extension for TestRestTemplate.postForEntity providing a postForEntity<Foo>(...) variant leveraging Kotlin reified type parameters. Like the original Java method, this extension is subject to type erasure. Use exchange if you need to retain actual generic type arguments.

postForObject

inline fun <T : Any> TestRestTemplate.postForObject(url: URI, request: Any? = null): T?

inline fun <T : Any> TestRestTemplate.postForObject(url: String, request: Any? = null, vararg uriVariables: Any): T?

inline fun <T : Any> TestRestTemplate.postForObject(url: String, request: Any? = null, uriVariables: Map<String, *>): T?

Extension for TestRestTemplate.postForObject providing a postForObject<Foo>(...) variant leveraging Kotlin reified type parameters. Like the original Java method, this extension is subject to type erasure. Use exchange if you need to retain actual generic type arguments.