rest
REST methods that can send HTTP body (POST, PATCH, PUT and DELETE) may take a single parameter annotated as Body which will be encoded as HttpBody and sent as the body of HTTP request.
REST method parameters annotated as BodyField will be encoded as either JsonValue and combined into a JSON object that will be sent as HTTP body.
REST method parameters annotated as BodyField will be encoded as either JsonValue and combined into a JSON object that will be sent as HTTP body. Body parameters are allowed only in REST methods annotated as POST, PATCH, PUT or DELETE. Actually, parameters of these methods are interpreted as BodyField by default which means that this annotation rarely needs to be applied explicitly.
Base trait for annotations representing HTTP methods which may define a HTTP body.
Base trait for annotations representing HTTP methods which may define a 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 as 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 MIME 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]
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 GenCodec and GenKeyCodec based serialization and 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 GenCodec and GenKeyCodec based serialization.
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 GenCodec and GenKeyCodec based serialization and forces derivation of
OpenApiMetadata.
Causes the body parameters of a HTTP REST method to be encoded as application/x-www-form-urlencoded.
Causes the body parameters of a HTTP REST method to be encoded as application/x-www-form-urlencoded.
Each parameter value itself will be first serialized to QueryValue.
This annotation only applies to methods which include HTTP body (i.e. not GET) and it must not be
a method with a single body parameter (Body). Methods with single body parameter can send their body
as application/x-www-form-urlencoded by defining custom serialization of its parameter into HttpBody.
REST method annotated as @GET will translate to HTTP GET request.
REST method annotated as @GET will translate to HTTP GET request. By default, parameters of such method
are translated into URL query parameters (encoded as QueryValue). Alternatively, each parameter
may be annotated as 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 as Header will be encoded as HeaderValue and added to HTTP headers.
REST method parameters annotated as Header will be encoded as HeaderValue and added to HTTP headers. Header name must be explicitly given as argument of this annotation.
Value used as encoding of Header parameters.
Value used to represent HTTP body.
Value used to represent HTTP body. Also used as direct encoding of Body parameters. Types that have
encoding to JsonValue automatically have encoding to HttpBody which uses application/json MIME type.
There is also a specialized encoding provided for Unit which returns empty HTTP body when writing and ignores
the body when reading.
Enum representing HTTP methods.
Typeclass used during RestMetadata materialization to determine whether a real method is a valid HTTP method.
Typeclass used during RestMetadata materialization to determine whether a real method is a valid HTTP
method. Usually this means that the result must be a type wrapped into something that captures asynchronous
computation, e.g. Future. Because REST framework core tries to be agnostic about this
asynchronous wrapper (not everyone likes Futures), there are no default implicits provided for HttpResponseType.
They must be provided externally.
For example, FutureRestImplicits introduces an instance of HttpResponseType for Future[T],
for arbitrary type T. For RestMetadata materialization this means that every method which returns a
Future is considered a valid HTTP method. FutureRestImplicits is injected into materialization of
RestMetadata through one of the base companion classes, e.g. DefaultRestApiCompanion.
See MacroInstances for more information on injection of implicits.
Value used as encoding of BodyField parameters of non-FormBody methods.
See BodyMethodTag
See BodyMethodTag
See BodyMethodTag
REST method parameters annotated as Path will be encoded as PathValue and appended to URL path, in the declaration order.
Value used as encoding of Path parameters.
REST methods annotated as Prefix are expected to return another REST API trait as their result.
REST methods annotated as 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 PathValue and appended to URL path. Alternatively, each parameter may also be explicitly annotated as 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 as Query will be encoded as QueryValue and added to URL query parameters.
REST method parameters annotated as Query will be encoded as QueryValue and added to URL query parameters. Parameters of GET REST methods are interpreted as Query parameters by default.
Value used as encoding of Query parameters and BodyField parameters of FormBody methods.
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 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 Future[Result] where
Result is encodable as RestResponse.
If a REST method is not annotated with any of HTTP method tags, Prefix is assumed by default which 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 some other REST API trait.
REST methods that can send HTTP body (POST, PATCH, PUT and DELETE) may take a single parameter annotated as Body which will be encoded as HttpBody and sent as the body of HTTP request. Such a method may not define any other body parameters (although it may take additional Path, Header or Query parameters).
The single body parameter may have a completely custom encoding to HttpBody which may define its own MIME type and doesn't necessarily have to be JSON.