Module io.avaje.http.api

Package io.avaje.http.api

package io.avaje.http.api

Provides annotations to support Controllers for web frameworks that are route based (like Sparkjava, Javlin etc).

Related Packages

Package	Description
io.avaje.http.api.context
io.avaje.http.api.spi

Class	Description
BeanParam	A parameter that is a bean containing query parameters, headers and cookies.
BodyString	Marks a controller string method parameter to be a string body.
Client	Marker annotation for client.
Client.Import	Specify @Client.Import on a package or class to refer to the client interface we want to generate.
Consumes	Specify endpoint request media type for the generated OpenAPI json.
Controller	Marker annotation for controllers.
Cookie	A parameter that is a cookie value.
Default	Define a default value for a form parameter or query parameter.
Delete	Marks a method that handles HTTP DELETE requests.
Form	A parameter that is a bean containing form parameters.
FormParam	Marks a method parameter to be a form parameter.
Generated	Marker for generated code.
Get	Marks a method that handles HTTP GET requests.
Header	A parameter that is a header value.
HttpMethod	Base for Http verb based annotations.
Ignore	Mark a field on a BeanParam/FormParam class as not a request parameter of any kind.
InstrumentServerContext	Marks a controller method to be instrumented with RequestContextResolver.
InvalidPathArgumentException	Exception for all invalid path type conversions - numbers, uuid, date time types etc.
InvalidTypeArgumentException	Exception for all invalid path type conversions - numbers, uuid, date time types etc.
MatrixParam	Marks a method parameter to be a matrix parameter.
MediaType	Common media types used by controllers.
OpenAPIResponse	Specify endpoint response status code/description/type.
OpenAPIResponses	Container for repeatable OpenAPIResponse annotation
Patch	Marks a method that handles HTTP PATCH requests.
Path	Specify the path mapping request to the controller.
PathSegment	A path segment that can simple like value like chair or contain matrix parameter values using semi-colon delimitation like chair;vendor=ikea;size=small.
PathTypeConversion	Helper type conversion methods.
Post	Marks a method that handles HTTP POST requests.
Produces	Specify endpoint response media type.
Put	Marks a method that handles HTTP PUT requests.
QueryParam	Marks a method parameter to be a query parameter.
RequestTimeout	Overrides global request timeout for this endpoint.
RequiredArgumentException	Exception for parameters that are required.
Valid	Add @Valid annotation on a controller/method/BeanParam that we want bean validation to be included for.
ValidationException	Exception used with Validator.
ValidationException.Violation	Error details including the field, error message and path
Validator	Validator for form beans or request beans.
WebRoutes	Registers routes to a web framework.