Module rxmicro.rest

Package io.rxmicro.rest

The root package for the rxmicro.rest module.

Since:

0.4

Author:

nedis

Enum Summary

Enum	Description
BaseUrlPath.Position	Contains supported positions.
Version.Strategy	REST version strategy.

Annotation Types Summary

Annotation Type	Description
AddHeader	Denotes a static HTTP header that must be added to the response, created by the request handler from REST controller or denotes a static HTTP header that must be added to the request, formed by the request handler from REST client.
AddHeader.List	Defines several AddHeader annotations on the same element.
AddQueryParameter	Denotes a static query parameter that must be added to the request, created by REST client implementation.
AddQueryParameter.List	Defines several AddQueryParameter annotations on the same element.
BaseUrlPath	Base url path for all http endpoints.
BaseUrlPath.List	Defines several BaseUrlPath annotations on the same element.
Header	Maps HTTP header to annotated class field.
HeaderMappingStrategy	Declares a strategy of header name formation based on Java model field name analysis.
Parameter	Maps HTTP parameter extracted from HTTP body or HTTP query string to annotated class field.
ParameterMappingStrategy	Declares a strategy of parameter name formation based on Java model field name analysis.
PathVariable	Maps HTTP path variable to annotated class field.
RemoteAddress	Declares the Java model field as a field, in which which the RxMicro framework must inject the remote client connection address.
RepeatHeader	Informs the RxMicro Annotation Processor, that a header model field with array type must be converted to the repeating HTTP header.
RepeatQueryParameter	Informs the RxMicro Annotation Processor, that a query parameter model field with array type must be converted to the repeating query parameter.
RequestBody	Declares the Java model field as a field, in which the RxMicro framework adds a body of the received request.
RequestId	Returns value of HTTP header with name = "Request-Id" or auto generated unique request id if HTTP header is absent.
RequestMethod	Declares the Java model field as a field, in which the RxMicro framework must inject a method of the received request.
RequestUrlPath	Declares the Java model field as a field, in which the RxMicro framework must inject URL path of the received request.
ResponseBody	Indicates to the RxMicro framework that the value of the Java model field should be used as a body to be sent to the client.
ResponseStatusCode	Indicates to the RxMicro framework that the value of the Java model field should be used as a status code to be sent to the client.
SetHeader	Denotes a static HTTP header that must be set to the response, created by the request handler from REST controller or denotes a static HTTP header that must be set to the request, formed by the request handler from REST client.
SetHeader.List	Defines several SetHeader annotations on the same element.
SetQueryParameter	Denotes a static query parameter that must be set to the request, created by REST client implementation.
SetQueryParameter.List	Defines several SetQueryParameter annotations on the same element.
Version	Denotes a version of the REST controller or REST client.