See: Description
| Interface | Description |
|---|---|
| DecoratorFactoryFunction<T extends Annotation> |
A decorator factory which is used for a user-defined decorator annotation.
|
| ExceptionHandlerFunction |
An interface for exception handler.
|
| HttpResult<T> |
An interface which helps a user specify an
HttpStatus or ResponseHeaders for a response
produced by an annotated HTTP service method. |
| RequestConverterFunction |
Converts an
AggregatedHttpRequest to an object. |
| ResponseConverterFunction |
Converts a
result object to HttpResponse. |
| ResponseConverterFunctionProvider |
A
ResponseConverterFunction provider interface which creates a new
ResponseConverterFunction for converting an object of the given type and functions. |
| Class | Description |
|---|---|
| ByteArrayRequestConverterFunction |
A default implementation of a
RequestConverterFunction which converts a binary body of
the AggregatedHttpRequest to one of byte[] or HttpData. |
| ByteArrayResponseConverterFunction |
A response converter implementation which creates an
HttpResponse with
content-type: application/binary or content-type: application/octet-stream. |
| JacksonRequestConverterFunction |
A default implementation of a
RequestConverterFunction which converts a JSON body of
the AggregatedHttpRequest to an object by ObjectMapper. |
| JacksonResponseConverterFunction |
A response converter implementation which creates an
HttpResponse with
content-type: application/json; charset=utf-8 or content-type: application/json-seq. |
| NullToNoContentResponseConverterFunction |
A response converter implementation which creates an
HttpResponse of HttpStatus.NO_CONTENT
when the specified result is null. |
| ServerSentEventResponseConverterFunction |
A response converter implementation which creates an
HttpResponse with
content-type: text/event-stream. |
| StringRequestConverterFunction |
A default implementation of a
RequestConverterFunction which converts a text body of
the AggregatedHttpRequest to a String. |
| StringResponseConverterFunction |
A response converter implementation which creates an
HttpResponse with
content-type: text/plain. |
| Enum | Description |
|---|---|
| ExceptionVerbosity |
The verbosity of exceptions logged by annotated HTTP services.
|
| Annotation Type | Description |
|---|---|
| AdditionalHeader |
Annotation for an additional HTTP header.
|
| AdditionalHeaders |
The containing annotation type for
AdditionalHeader. |
| AdditionalTrailer |
Annotation for an additional HTTP trailer.
|
| AdditionalTrailers |
The containing annotation type for
AdditionalTrailer. |
| Blocking |
Specifies that the annotated service method must be invoked from the
blocking task executor
instead of an event loop thread.
|
| Consumes |
Specifies a media type which would be consumed by the service method or class.
|
| ConsumesBinary |
An alias for
@Consumes(MediaTypeNames.APPLICATION_BINARY). |
| ConsumesGroup |
The containing annotation type for
Consumes. |
| ConsumesJson |
An alias for
@Consumes(MediaTypeNames.JSON). |
| ConsumesOctetStream |
An alias for
@Consumes(MediaTypeNames.OCTET_STREAM). |
| ConsumesText |
An alias for
@Consumes(MediaTypeNames.PLAIN_TEXT_UTF_8). |
| ConsumeType | Deprecated
Use
Consumes. |
| ConsumeTypes | Deprecated
Use
ConsumesGroup. |
| Decorator |
Specifies a
DecoratingHttpServiceFunction class which handles an HttpRequest before invoking
an annotated service method. |
| DecoratorFactory |
Specifies a
DecoratorFactoryFunction class which is a factory to create a decorator. |
| Decorators |
The containing annotation type for
Decorator. |
| Default |
Specifies the default value of an optional parameter.
|
| Delete |
Annotation for mapping
HttpMethod.DELETE onto specific method. |
| Description |
An annotation used in annotated HTTP service.
|
| ExceptionHandler |
Specifies an
ExceptionHandlerFunction class which handles exceptions throwing from an
annotated service method. |
| ExceptionHandlers |
The containing annotation type for
ExceptionHandler. |
| Get |
Annotation for mapping
HttpMethod.GET onto specific method. |
| Head |
Annotation for mapping
HttpMethod.HEAD onto specific method. |
| Header |
Annotation for mapping an HTTP request header onto the following elements.
|
| MatchesHeader |
Specifies a predicate which evaluates whether a request can be accepted by a service method.
|
| MatchesHeaders |
The containing annotation type for
MatchesHeader. |
| MatchesParam |
Specifies a predicate which evaluates whether a request can be accepted by a service method.
|
| MatchesParams |
The containing annotation type for
MatchesParam. |
| Options |
Annotation for mapping
HttpMethod.OPTIONS onto specific method. |
| Order |
Specifies an order which is used to sort the annotated service methods.
|
| Param |
Annotation for mapping a parameter of a request onto the following elements.
|
| Patch |
Annotation for mapping
HttpMethod.PATCH onto specific method. |
| Path |
Annotation for mapping dynamic web requests onto specific method.
|
| PathPrefix |
Annotation that can be used on a class as a path prefix for all the
methods that handle http request.
|
| Paths |
The containing annotation type for
Path. |
| Post |
Annotation for mapping
HttpMethod.POST onto specific method. |
| Produces |
Specifies a media type which would be produced by the service method or class.
|
| ProducesBinary |
An alias for
@Produces(MediaTypeNames.APPLICATION_BINARY). |
| ProducesEventStream |
An alias for
@Produces(MediaTypeNames.EVENT_STREAM) and
@ResponseConverter(ServerSentEventResponseConverterFunction.class). |
| ProducesGroup |
The containing annotation type for
Produces. |
| ProducesJson |
An alias for
@Produces(MediaTypeNames.JSON_UTF_8). |
| ProducesJsonSequences |
An alias for
@Produces(MediaTypeNames.JSON_SEQ). |
| ProducesOctetStream |
An alias for
@Produces(MediaTypeNames.OCTET_STREAM). |
| ProducesText |
An alias for
@Produces(MediaTypeNames.PLAIN_TEXT_UTF_8). |
| ProduceType | Deprecated
Use
Produces. |
| ProduceTypes | Deprecated
Use
ProducesGroup. |
| Put |
Annotation for mapping
HttpMethod.PUT onto specific method. |
| RequestConverter |
Specifies a
RequestConverterFunction class which converts an AggregatedHttpRequest to
an object. |
| RequestConverters |
The containing annotation type for
RequestConverter. |
| RequestObject |
Specifies which element should be converted by
RequestConverterFunction. |
| ResponseConverter |
Specifies a
ResponseConverterFunction class which converts the result to HttpResponse. |
| ResponseConverters |
The containing annotation type for
ResponseConverter. |
| StatusCode |
An annotation which specifies a default HTTP status code of a response produced by an annotated HTTP service.
|
| Trace |
Annotation for mapping
HttpMethod.TRACE onto specific method. |
Copyright © 2020 LeanCloud. All rights reserved.