mirror of
https://github.com/spring-projects/spring-framework.git
synced 2026-09-20 20:59:07 +00:00
Improve Javadoc for use of ApiVersionInserter
Closes gh-35565
This commit is contained in:
+3
@@ -447,6 +447,9 @@ public interface WebTestClient {
|
||||
* Configure an {@link ApiVersionInserter} to abstract how an API version
|
||||
* specified via {@link RequestHeadersSpec#apiVersion(Object)}
|
||||
* is inserted into the request.
|
||||
* <p>{@code ApiVersionInserter} exposes shortcut methods for several
|
||||
* built-in inserter implementation types. See the class-level Javadoc
|
||||
* of {@link ApiVersionInserter} for a list of choices.
|
||||
* @param apiVersionInserter the inserter to use
|
||||
* @since 7.0
|
||||
*/
|
||||
|
||||
+3
@@ -263,6 +263,9 @@ public interface RestTestClient {
|
||||
* Configure an {@link ApiVersionInserter} to abstract how an API version
|
||||
* specified via {@link RequestHeadersSpec#apiVersion(Object)}
|
||||
* is inserted into the request.
|
||||
* <p>{@code ApiVersionInserter} exposes shortcut methods for several
|
||||
* built-in inserter implementation types. See the class-level Javadoc
|
||||
* of {@link ApiVersionInserter} for a list of choices.
|
||||
* @param apiVersionInserter the inserter to use
|
||||
*/
|
||||
<T extends B> T apiVersionInserter(ApiVersionInserter apiVersionInserter);
|
||||
|
||||
+3
@@ -496,6 +496,9 @@ public abstract class AbstractMockHttpServletRequestBuilder<B extends AbstractMo
|
||||
* An inserter may typically be set once (more centrally) via
|
||||
* {@link org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder#defaultRequest(RequestBuilder)}, or
|
||||
* {@link org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder#apiVersionInserter(ApiVersionInserter)}.
|
||||
* <p>{@code ApiVersionInserter} exposes shortcut methods for several
|
||||
* built-in inserter implementation types. See the class-level Javadoc
|
||||
* of {@link ApiVersionInserter} for a list of choices.
|
||||
* @param versionInserter the inserter to use
|
||||
* @since 7.0
|
||||
*/
|
||||
|
||||
+3
@@ -80,6 +80,9 @@ public interface ConfigurableMockMvcBuilder<B extends ConfigurableMockMvcBuilder
|
||||
/**
|
||||
* Set the {@link ApiVersionInserter} to use to apply to versions specified via
|
||||
* {@link org.springframework.test.web.servlet.request.AbstractMockHttpServletRequestBuilder#apiVersion(Object)}.
|
||||
* <p>{@code ApiVersionInserter} exposes shortcut methods for several
|
||||
* built-in inserter implementation types. See the class-level Javadoc
|
||||
* of {@link ApiVersionInserter} for a list of choices.
|
||||
* @param versionInserter the inserter to use
|
||||
* @since 7.0
|
||||
*/
|
||||
|
||||
@@ -23,8 +23,19 @@ import org.jspecify.annotations.Nullable;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
|
||||
/**
|
||||
* Contract to determine how to insert an API version into the URI or headers
|
||||
* of a request.
|
||||
* Contract to insert an API version into the URI or headers of a request.
|
||||
*
|
||||
* <p>Use shortcut, static factory methods on this interface to create one of
|
||||
* the built-in inserter type implementations:
|
||||
* <ul>
|
||||
* <li>{@link #useHeader(String)}
|
||||
* <li>{@link #useQueryParam(String)}
|
||||
* <li>{@link #useMediaTypeParam(String)}
|
||||
* <li>{@link #usePathSegment(Integer)}
|
||||
* </ul>
|
||||
*
|
||||
* <p>Use the {@link #builder()} for further options such as if you want to also
|
||||
* configure an {@link ApiVersionFormatter}.
|
||||
*
|
||||
* @author Rossen Stoyanchev
|
||||
* @since 7.0
|
||||
|
||||
@@ -347,6 +347,9 @@ public interface RestClient {
|
||||
* Configure an {@link ApiVersionInserter} to abstract how an API version
|
||||
* specified via {@link RequestHeadersSpec#apiVersion(Object)}
|
||||
* is inserted into the request.
|
||||
* <p>{@code ApiVersionInserter} exposes shortcut methods for several
|
||||
* built-in inserter implementation types. See the class-level Javadoc
|
||||
* of {@link ApiVersionInserter} for a list of choices.
|
||||
* @param apiVersionInserter the inserter to use
|
||||
* @since 7.0
|
||||
*/
|
||||
|
||||
+3
@@ -265,6 +265,9 @@ public interface WebClient {
|
||||
* Configure an {@link ApiVersionInserter} to abstract how an API version
|
||||
* specified via {@link RequestHeadersSpec#apiVersion(Object)}
|
||||
* is inserted into the request.
|
||||
* <p>{@code ApiVersionInserter} exposes shortcut methods for several
|
||||
* built-in inserter implementation types. See the class-level Javadoc
|
||||
* of {@link ApiVersionInserter} for a list of choices.
|
||||
* @param apiVersionInserter the inserter to use
|
||||
* @since 7.0
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user