Package com.shri.restinpeace.annotation.request

package com.shri.restinpeace.annotation.request

Annotation Types

Class	Description
Body	Sends the annotated parameter as the request body.
Destination	Marks the java.io.File parameter a File-returning method writes its response body into, instead of buffering the whole body into a byte[]:
Field	One name/value pair of a @FormUrlEncoded method's form-urlencoded body.
FieldMap	A Map<String, ?> parameter of a @FormUrlEncoded method adding one form field per entry, for a set of field names not known until runtime - the @FieldMap counterpart to @QueryMap and @PartMap.
FormUrlEncoded	Marks a method as sending an application/x-www-form-urlencoded body built from its @Field/@FieldMap-annotated parameters, instead of the JSON/raw-string body a @Body parameter would send, or the multipart/form-data body @Multipart would send.
HeaderMap	Sets an HTTP header for each entry of the annotated Map<String, ?> parameter, for a set of headers whose names aren't known until runtime - e.g. caller-supplied headers in a multi-tenant app.
HeaderParam	Sets an HTTP header on the request from the annotated parameter's value.
Headers	Sets one or more fixed HTTP headers on every call of the annotated method, each given as a "Name: Value" string - for a header whose value is always the same (e.g.
Multipart	Marks a method as sending a multipart/form-data body built from its @Part/@PartMap-annotated parameters, instead of the JSON/raw-string body a @Body parameter would send.
Part	One field of a @Multipart method's multipart body.
PartMap	A Map<String, ?> parameter of a @Multipart method adding one part per entry, for a set of field names not known until runtime - the @Part counterpart to @QueryMap and @HeaderMap.
PathParam	Substitutes a {name} placeholder in the method's URL template with the annotated parameter's value.
QueryMap	Appends a query string parameter for each entry of the annotated Map<String, ?> parameter, for a set of query params whose names aren't known until runtime - e.g. a search endpoint's open-ended filter set.
QueryParam	Appends a query string parameter to the request from the annotated parameter's value.
Url	Uses the annotated String parameter as the method's entire URL, instead of resolving one from the HTTP method annotation's template (with @BaseUrl/a runtime base URL and @PathParams).