Package io.micronaut.http.annotation
HTTP annotations representing various requests types that are received.
- Since:
- 1.0
-
Annotation Types Summary Annotation Type Description Body An annotation that can be applied to method argument to indicate that the method argument is bound from the HTTP body.Consumes An annotation to indicate theMediaType
s produced by a particular component.Controller Indicates that the role of a class is a controller within an application.CookieValue An annotation that can be applied to method argument to indicate that the method argument is bound from an HTTP cookie.CustomHttpMethod This annotation is designed for non-standard http methods, that you can provide by specifying the requiredCustomHttpMethod.method()
property.Delete Annotation that can be applied to method to signify the method receives aHttpMethod.DELETE
.Error Annotation that can be applied to method to map it to an error route.Filter An annotation that can be applied to classes that implementHttpFilter
to specify the patterns.FilterMatcher Stereotype annotation that helps to link together instance of the filter and http client that filter should be applied to.Get Annotation that can be applied to method to signify the method receives aHttpMethod.GET
.Head Annotation that can be applied to method to signify the method receives aHttpMethod.HEAD
.Header An annotation that can be applied to method argument to indicate that the method argument is bound from an HTTP header This also can be used in conjunction with @Headers to list headers on a client class that will always be applied.Headers This lets you declare several headers for a client class and have them always included.HttpMethodMapping A meta annotation for HTTPController
actions.Options Annotation that can be applied to method to signify the method receives aHttpMethod.OPTIONS
.Part An annotation that can be applied to method argument to indicate that the method argument is bound from a specific part of a "multipart/form-data" request.Patch Annotation that can be applied to method to signify the method receives aHttpMethod.PATCH
.PathVariable Used to bind a parameter exclusively from a path variable.Post Annotation that can be applied to method to signify the method receives aHttpMethod.POST
.Produces An annotation to indicate theMediaType
s produced by a particular component.Put Annotation that can be applied to method to signify the method receives aHttpMethod.PUT
.QueryValue Indicates that the parameter to a method should be bound from a value in the query string or path of the URI.RequestAttribute An annotation that can be applied to method arguments to indicate that the method argument is bound to an HTTP request attribute This can also be used in conjuction with @RequestAttributes to list attributes on a client class that will always be applied Note: Request attributes are intended for internal data sharing only, and are not attached to the outbound request.RequestAttributes This lets you declare several attributes for a client class and have them always included.RequestBean Used to bind Bindable parameters to a Bean object.Status Sets alternative HttpStatus response code when applied to a method and HttpStatus code is specified.Trace Annotation that can be applied to method to signify the method receives aHttpMethod.TRACE
.UriMapping Meta annotation for the mapped URI whether at the controller or action level.