rest
REST method parameters annotated with Body will be used to build HTTP request body.
Base trait for annotations representing HTTP methods which may define an HTTP body.
Base trait for annotations representing HTTP methods which may define an HTTP body. This includes PUT, POST, PATCH and DELETE. Parameters of REST methods annotated with one of these tags are by default serialized into JSON (through encoding to JsonValue) and combined into JSON object that is sent as HTTP body.
Parameters may also contribute to URL path, HTTP headers and query parameters if annotated with Path, Header or Query.
REST method may also take a single parameter representing the entire HTTP body. Such parameter must be annotated as Body and must be the only body parameter of that method. Value of this parameter will be encoded as HttpBody which doesn't necessarily have to be JSON (it may define its own media type).
trait SomeRestApi { @POST("users/create") def createUser(@Body user: User): Future[Unit] @PATCH("users/update") def updateUser(id: String, name: String): Future[User] } object SomeRestApi extends RestApiCompanion[SomeRestApi]
Base trait for tag annotations which specify how an HTTP body is built for invocation of particular method.
Base trait for tag annotations which specify how an HTTP body is built for invocation of particular method. The default one is JsonBody.
REST method parameterrs annotated with Query will be encoded as
PlainValue and sent as cookie values (using Cookie HTTP header).
REST method parameterrs annotated with Query will be encoded as
PlainValue and sent as cookie values (using Cookie HTTP header).
Cookie parameter values must not contain ';' character (semicolon).
Requires that a method takes exactly one Body parameter which serializes directly into HttpBody.
See BodyMethodTag
Base class for companions of REST API traits used for both REST clients and servers.
Base class for companions of REST API traits used for both REST clients and servers.
Injects Future as the wrapper for asynchronous responses and GenCodec/GenKeyCodec based serialization
for parameters and responses.
Also, forces derivation of OpenApiMetadata.
Base class for companions of REST API traits used only for REST clients to external services.
Base class for companions of REST API traits used only for REST clients to external services.
Injects Future as the wrapper for asynchronous responses and GenCodec/GenKeyCodec based serialization
for parameters and responses.
Base class for companions of REST API traits used only for REST servers exposed to external world.
Base class for companions of REST API traits used only for REST servers exposed to external world.
Injects Future as the wrapper for asynchronous responses and GenCodec/GenKeyCodec based serialization
for parameters and responses.
Also, forces derivation of OpenApiMetadata.
Causes the Body parameters of an HTTP REST method to be encoded as
application/x-www-form-urlencoded.
Causes the Body parameters of an HTTP REST method to be encoded as
application/x-www-form-urlencoded. Each parameter value itself will be first serialized to
PlainValue.
This annotation only applies to methods which may include HTTP body (i.e. not GET).
REST method annotated with @GET will translate to HTTP GET request.
REST method annotated with @GET will translate to HTTP GET request. By default, parameters of such method
are translated into URL query parameters (encoded as PlainValue).
Alternatively, each parameter may be annotated with Path or Header
which means that it will be translated into HTTP header value.
Defines GenCodec and GenKeyCodec based serialization for REST API traits.
REST method parameters annotated with Header will be encoded as PlainValue and added to HTTP headers.
REST method parameters annotated with Header will be encoded as PlainValue and added to HTTP headers. Header name must be explicitly given as argument of this annotation.
Base class for RestMethodTags representing actual HTTP methods, as opposed to Prefix methods.
Causes the Body parameters of an HTTP REST method to be encoded as application/json.
Causes the Body parameters of an HTTP REST method to be encoded as application/json.
Each parameter value itself will be first serialized to JsonValue.
This annotation only applies to methods which may include HTTP body (i.e. not GET)
and is assumed by default, so there should be no reason to apply it explicitly.
Indicates that an HTTP REST method takes no body.
See BodyMethodTag
See BodyMethodTag.
See BodyMethodTag. This is the default tag for untagged methods which are not recognized as Prefix methods (i.e. their result type is not another REST trait).
See BodyMethodTag
REST method parameters annotated with Path will be encoded as PlainValue and appended to URL path, in the declaration order.
REST method parameters annotated with Path will be encoded as PlainValue and appended to URL path, in the declaration order. Parameters of Prefix REST methods are interpreted as Path parameters by default.
REST methods annotated with Prefix are expected to return another REST API trait as their result.
REST methods annotated with Prefix are expected to return another REST API trait as their result. They do not yet represent an actual HTTP request but contribute to URL path, HTTP headers and query parameters.
By default, parameters of a prefix method are interpreted as URL path fragments. Their values are encoded as PlainValue and appended to URL path. Alternatively, each parameter may also be explicitly annotated with Header or Query.
NOTE: REST method is interpreted as prefix method by default which means that there is no need to apply Prefix annotation explicitly unless you want to specify a custom path.
REST method parameters annotated with Query will be encoded as PlainValue and added to URL query parameters.
REST method parameters annotated with Query will be encoded as PlainValue and added to URL query parameters. Parameters of GET REST methods are interpreted as Query parameters by default.
Base trait for annotations which may be applied on REST API methods (including prefix methods) in order to customize outgoing request on the client side.
Base trait for annotations which may be applied on REST API methods (including prefix methods) in order to customize outgoing response on the server side.
Base class for REST trait companions.
Base class for REST trait companions. Reduces boilerplate needed in order to define appropriate instances
of AsRawReal and RestMetadata for given trait. The Implicits type parameter lets you inject additional implicits
into macro materialization of these instances, e.g. DefaultRestImplicits.
Usually, for even less boilerplate, this base class is extended by yet another abstract class which fixes
the Implicits type, e.g. DefaultRestApiCompanion.
Base class for companion objects of ADTs (case classes, objects, sealed hierarchies) which are used as parameter or result types in REST API traits.
Base class for companion objects of ADTs (case classes, objects, sealed hierarchies) which are used as
parameter or result types in REST API traits. Automatically provides instances of
GenCodec and RestSchema.
case class User(id: String, name: String, birthYear: Int) object User extends RestDataCompanion[User]
Base class for companion objects of wrappers over other data types (i.e.
Base class for companion objects of wrappers over other data types (i.e. case classes with single field). This companion ensures instances of all the REST typeclasses (serialization, schema, etc.) for wrapping type assuming that these instances are available for the wrapped type.
Using this base companion class makes the wrapper class effectively "transparent", i.e. as if it was annotated with transparent annotation.
case class UserId(id: String) extends AnyVal object UserId extends RestDataWrapperCompanion[String, UserId]
Base trait for tag annotations that determine how a REST method is translated into actual HTTP request.
Base trait for tag annotations that determine how a REST method is translated into actual HTTP request.
A REST method may be annotated with one of HTTP method tags (GET, PUT,
POST, PATCH, DELETE)
which means that this method represents actual HTTP call and is expected to return a AsyncWrapper[Result] where
Result is encodable as RestResponse and AsyncWrapper represents some
abstraction over asynchronous computations (Future by default - see
DefaultRestApiCompanion).
If a REST method is not annotated with any of HTTP method tags, then either POST is assumed (if result type is a valid result type for HTTP method) or Prefix is assumed (if result type is another REST trait). Prefix means that this method only contributes to URL path, HTTP headers and query parameters but does not yet represent an actual HTTP request. Instead, it is expected to return instance of some other REST API trait which will ultimately determine the actual HTTP call.
Annotation which may be applied on REST API methods (including prefix methods) in order to append additional HTTP header to all outgoing requests generated for invocations of that method on the client side.
Annotation which may be applied on REST API methods (including prefix methods) in order to append additional HTTP header to all outgoing responses generated for invocations of that method on the server side.
Convenience implementation of RequestAdjuster.
Convenience implementation of ResponseAdjuster.
REST method parameters annotated with Body will be used to build HTTP request body. How exactly that happens depends on BodyTypeTag applied on a method. By default, JsonBody is assumed which means that body parameters will be combined into a single JSON object sent as body.
Body parameters are allowed only in REST methods annotated with POST, PATCH, PUT or DELETE. Actually, for these methods, an unannotated parameter is assumed to be a body parameter by default. This means that there's usually no reason to apply this annotation explicitly. It may only be useful when wanting to customize JSON/form field name which this annotation takes as its argument