Links from @RequestMapping to reference docs
Issue: SPR-16266
This commit is contained in:
parent
73cad470e5
commit
446e7ed25c
|
|
@ -25,21 +25,33 @@ import java.lang.annotation.Target;
|
||||||
import org.springframework.core.annotation.AliasFor;
|
import org.springframework.core.annotation.AliasFor;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Annotation for mapping web requests onto specific handler classes and/or
|
* Annotation for mapping web requests onto methods in request-handling classes
|
||||||
* handler methods.
|
* with flexible method signatures.
|
||||||
*
|
*
|
||||||
* <p>Handler methods annotated with this annotation can have very flexible
|
* <p>Both Spring MVC and Spring WebFlux support this annotation through a
|
||||||
* signatures. The exact details of the supported method arguments and return
|
* {@code RequestMappingHandlerMapping} and {@code RequestMappingHandlerAdapter}
|
||||||
* values depend on the specific
|
* in their respective modules and package structure. For the exact list of
|
||||||
* {@link org.springframework.stereotype.Controller @Controller} model supported.
|
* supported handler method arguments and return types in each, please use the
|
||||||
* Both Spring Web MVC and Spring WebFlux support this annotation with some
|
* reference documentation links below:
|
||||||
* differences. More details are available in the Spring Framework reference.
|
* <ul>
|
||||||
|
* <li>Spring MVC
|
||||||
|
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#mvc-ann-arguments">Method Arguments</a>
|
||||||
|
* and
|
||||||
|
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#mvc-ann-return-types">Return Values</a>
|
||||||
|
* </li>
|
||||||
|
* <li>Spring WebFlux
|
||||||
|
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html#webflux-ann-arguments">Method Arguments</a>
|
||||||
|
* and
|
||||||
|
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html#webflux-ann-return-types">Return Values</a>
|
||||||
|
* </li>
|
||||||
|
* </ul>
|
||||||
*
|
*
|
||||||
* <p><b>NOTE:</b> {@code @RequestMapping} will only be processed if an
|
* <p><strong>Note:</strong> This annotation can be used both at the class and
|
||||||
* an appropriate {@code HandlerMapping}-{@code HandlerAdapter} pair
|
* at the method level. In most cases, at the method level applications will
|
||||||
* is configured. If you are defining custom {@code HandlerMappings} or
|
* prefer to use one of the HTTP method specific variants
|
||||||
* {@code HandlerAdapters}, then you need to add {@code RequestMappingHandlerMapping}
|
* {@link GetMapping @GetMapping}, {@link PostMapping @PostMapping},
|
||||||
* and {@code RequestMappingHandlerAdapter} to your configuration.</code>.
|
* {@link PutMapping @PutMapping}, {@link DeleteMapping @DeleteMapping}, or
|
||||||
|
* {@link PatchMapping @PatchMapping}.</p>
|
||||||
*
|
*
|
||||||
* <p><b>NOTE:</b> When using controller interfaces (e.g. for AOP proxying),
|
* <p><b>NOTE:</b> When using controller interfaces (e.g. for AOP proxying),
|
||||||
* make sure to consistently put <i>all</i> your mapping annotations - such as
|
* make sure to consistently put <i>all</i> your mapping annotations - such as
|
||||||
|
|
@ -55,13 +67,6 @@ import org.springframework.core.annotation.AliasFor;
|
||||||
* @see PutMapping
|
* @see PutMapping
|
||||||
* @see DeleteMapping
|
* @see DeleteMapping
|
||||||
* @see PatchMapping
|
* @see PatchMapping
|
||||||
* @see RequestParam
|
|
||||||
* @see RequestAttribute
|
|
||||||
* @see PathVariable
|
|
||||||
* @see ModelAttribute
|
|
||||||
* @see SessionAttribute
|
|
||||||
* @see SessionAttributes
|
|
||||||
* @see InitBinder
|
|
||||||
* @see org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter
|
* @see org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter
|
||||||
* @see org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
|
* @see org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerAdapter
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
|
|
@ -43,7 +43,9 @@ import org.springframework.web.reactive.result.method.InvocableHandlerMethod;
|
||||||
import org.springframework.web.server.ServerWebExchange;
|
import org.springframework.web.server.ServerWebExchange;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Supports the invocation of {@code @RequestMapping} methods.
|
* Supports the invocation of
|
||||||
|
* {@link org.springframework.web.bind.annotation.RequestMapping @RequestMapping}
|
||||||
|
* handler methods.
|
||||||
*
|
*
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
* @since 5.0
|
* @since 5.0
|
||||||
|
|
|
||||||
|
|
@ -98,13 +98,12 @@ import org.springframework.web.servlet.support.RequestContextUtils;
|
||||||
import org.springframework.web.util.WebUtils;
|
import org.springframework.web.util.WebUtils;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An {@link AbstractHandlerMethodAdapter} that supports {@link HandlerMethod}s
|
* Extension of {@link AbstractHandlerMethodAdapter} that supports
|
||||||
* with their method argument and return type signature, as defined via
|
* {@link RequestMapping} annotated {@code HandlerMethod}s.
|
||||||
* {@code @RequestMapping}.
|
|
||||||
*
|
*
|
||||||
* <p>Support for custom argument and return value types can be added via
|
* <p>Support for custom argument and return value types can be added via
|
||||||
* {@link #setCustomArgumentResolvers} and {@link #setCustomReturnValueHandlers}.
|
* {@link #setCustomArgumentResolvers} and {@link #setCustomReturnValueHandlers},
|
||||||
* Or alternatively, to re-configure all argument and return value types,
|
* or alternatively, to re-configure all argument and return value types,
|
||||||
* use {@link #setArgumentResolvers} and {@link #setReturnValueHandlers}.
|
* use {@link #setArgumentResolvers} and {@link #setReturnValueHandlers}.
|
||||||
*
|
*
|
||||||
* @author Rossen Stoyanchev
|
* @author Rossen Stoyanchev
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue