Defining endpoint’s input/output¶
An input is described by an instance of the
EndpointInput trait, and an output by an instance of the
trait, as all outputs can also be used as inputs. Each input or output can yield/accept a value. For example,
query[Int]("age"): EndpointInput[Int] describes an input, which is the
age query parameter, and which should be
mapped (using the string-to-integer codec) as an
tapir package contains a number of convenience methods to define an input or an output for an endpoint.
path[T], which captures a path segment as an input parameter of type
- any string, which will be implicitly converted to a constant path segment. Path segments can be combined with the
/method, and don’t map to any values (have type
paths, which maps to the whole remaining path as a
query[T](name)captures a query parameter with the given name
queryParamscaptures all query parameters, represented as
header[T](name)captures a header with the given name
headerscaptures all headers, represented as
cookie[T](name)captures a cookie from the
Cookieheader with the given name
cookiescaptures cookies from the
Cookieheader and represents them as
setCookie(name)captures the value & metadata of the a
Set-Cookieheader with a matching name
setCookiescaptures cookies from the
Set-Cookieheader and represents them as
multipartBody[T]captures the body
streamBody[S]captures the body as a stream: only a client/server interpreter supporting streams of type
Scan be used with such an endpoint
For outputs, you can use the
body family of methods.
Combining inputs and outputs¶
Endpoint inputs/outputs can be combined in two ways. However they are combined, the values they represent always accumulate into tuples of values.
First, descriptions can be combined using the
.and method. Such a combination results in an input/output represented
as a tuple of the given types, can be stored as a value and re-used in multiple endpoints. As all other values in tapir,
endpoint input/output descriptions are immutable. For example, an input specifying two query parameters,
limit (optional) can be written down as:
val paging: EndpointInput[(UUID, Option[Int])] = query[UUID]("start").and(query[Option[Int]]("limit")) // we can now use the value in multiple endpoints, e.g.: val listUsersEndpoint: Endpoint[(UUID, Option[Int]), Unit, List[User], Nothing] = endpoint.in("user" / "list").in(paging).out(jsonBody[List[User]])
Second, inputs can be combined by calling the
errorOut methods on
Endpoint multiple times. Each time
such a method is invoked, it extends the list of inputs/outputs. This can be useful to separate different groups of
parameters, but also to define template-endpoints, which can then be further specialized. For example, we can define a
base endpoint for our API, where all paths always start with
/api/v1.0, and errors are always returned as a json:
val baseEndpoint: Endpoint[Unit, ErrorInfo, Unit, Nothing] = endpoint.in("api" / "v1.0").errorOut(jsonBody[ErrorInfo])
Thanks to the fact that inputs/outputs accumulate, we can use the base endpoint to define more inputs, for example:
val statusEndpoint: Endpoint[Unit, ErrorInfo, Status, Nothing] = baseEndpoint.in("status").out(jsonBody[Status])
The above endpoint will correspond to the
Mapping over input values¶
Inputs/outputs can also be mapped over. As noted before, all mappings are bi-directional, so that they can be used both when interpreting an endpoint as a server, and as a client.
There’s a couple of ways to map over an input/output. First, there’s the
map[II](f: I => II)(g: II => I) method,
which accepts functions which provide the mapping in both directions. For example:
case class Paging(from: UUID, limit: Option[Int]) val paging: EndpointInput[Paging] = query[UUID]("start").and(query[Option[Int]]("limit")) .map((from, limit) => Paging(from, limit))(paging => (paging.from, paging.limit))
Creating a mapping between a tuple and a case class is a common operation, hence there’s also a
mapTo(CaseClassCompanion) method, which automatically provides the mapping functions:
case class Paging(from: UUID, limit: Option[Int]) val paging: EndpointInput[Paging] = query[UUID]("start").and(query[Option[Int]]("limit")) .mapTo(Paging)
Mapping methods can also be called on an endpoint (which is useful if inputs/outputs are accumulated, for example).
Endpoint.mapInTo etc. have the same signatures are the ones above.
By default (as with all other types of inputs), if no path input/path segments are defined, any path will match.
If any path input/path segment is defined, the path must match exactly - any remaining path segments will cause the
endpoint not to match the request. For example,
endpoint.path("api") will match
/api/, but won’t match
To match only the root path, use an empty string:
endpoint.path("") will match
It is possible to specify how the value of an output (typically the body) maps to the status code. This is used when interpreting the endpoint as a server and when generating documentation.
For example, below is a specification for an endpoint where the error output is fixed to be of type
such a specification can then be refined and reused for other endpoints:
case class ErrorInfo(errorType: ErrorType, msg: String) val baseEndpoint = endpoint.errorOut( statusFrom( jsonBody[ErrorType], StatusCodes.BadRequest, whenValue[ErrorType](_.errorType == ErrorType.NotFound, StatusCodes.NotFound), whenValue[ErrorType](_.errorType == ErrorType.Exception, StatusCodes.InternalServerError) ) )
statusFrom method takes as parameters: the wrapped output, default status code, and any number of specific
status codes mappings based on the value (
whenValue) or class (
whenClass) of the output value.