package tapir
- Alphabetic
- By Inheritance
- tapir
- Tapir
- ModifyMacroSupport
- ModifyMacroFunctorSupport
- TapirStaticContentEndpoints
- TapirComputedInputs
- TapirExtensions
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- type AnyEndpoint = Endpoint[_, _, _, _, _]
- type AnyListCodec = Codec[_ <: List[_], _, _ <: CodecFormat]
- type AnyPart = Part[_]
-
trait
Codec[L, H, +CF <: CodecFormat] extends AnyRef
A bi-directional mapping between low-level values of type
L
and high-level values of typeH
.A bi-directional mapping between low-level values of type
L
and high-level values of typeH
. Low level values are formatted asCF
.The mapping consists of a pair of functions, one to decode (
L => H
), and one to encode (H => L
) Decoding can fail, and this is represented as a result of type DecodeResult.A codec also contains optional meta-data on the
schema
of the high-level value, as well as an instance of the format (which determines the media type of the low-level value).Codec instances are used as implicit values, and are looked up when defining endpoint inputs/outputs. Depending on a particular endpoint input/output, it might require a codec which uses a specific format, or a specific low-level value.
Codec instances can be derived basing on other values (e.g. such as json encoders/decoders when integrating with json libraries). Or, they can be defined by hand for custom types, usually customising an existing, simpler codec.
Codecs can be chained with Mapping s using the
map
function.- L
The type of the low-level value.
- H
The type of the high-level value.
- CF
The format of encoded values. Corresponds to the media type.
- Annotations
- @implicitNotFound( ... )
- trait CodecExtensions extends AnyRef
-
trait
CodecFormat extends AnyRef
Specifies the format of the encoded values.
Specifies the format of the encoded values. Each variant must be a proper type so that it can be used as a discriminator for different (implicit) instances of Codec values.
- sealed trait DecodeResult[+T] extends AnyRef
- case class DocsExtension[A](key: String, value: A, codec: JsonCodec[A]) extends Product with Serializable
-
case class
Endpoint[A, I, E, O, -R](securityInput: EndpointInput[A], input: EndpointInput[I], errorOutput: EndpointOutput[E], output: EndpointOutput[O], info: EndpointInfo) extends EndpointSecurityInputsOps[A, I, E, O, R] with EndpointInputsOps[A, I, E, O, R] with EndpointErrorOutputsOps[A, I, E, O, R] with EndpointErrorOutputVariantsOps[A, I, E, O, R] with EndpointOutputsOps[A, I, E, O, R] with EndpointInfoOps[R] with EndpointMetaOps with EndpointServerLogicOps[A, I, E, O, R] with Product with Serializable
A description of an endpoint with the given inputs & outputs.
A description of an endpoint with the given inputs & outputs. The inputs are divided into two parts: security (
A
) and regular inputs (I
). There are also two kinds of outputs: error outputs (E
) and regular outputs (O
).In case there are no security inputs, the PublicEndpoint alias can be used, which omits the
A
parameter type.An endpoint can be interpreted as a server, client or documentation. The endpoint requires that server/client interpreters meet the capabilities specified by
R
(if any).When interpreting an endpoint as a server, the inputs are decoded and the security logic is run first, before decoding the body in the regular inputs. This allows short-circuiting further processing in case security checks fail. Server logic can be provided using EndpointServerLogicOps.serverSecurityLogic variants for secure endpoints, and EndpointServerLogicOps.serverLogic variants for public endpoints.
A concise description of an endpoint can be generated using the EndpointMetaOps.show method.
- A
Security input parameter types.
- I
Input parameter types.
- E
Error output parameter types.
- O
Output parameter types.
- R
The capabilities that are required by this endpoint's inputs/outputs. This might be
Any
(no requirements), sttp.capabilities.Effect (the interpreter must support the given effect type), sttp.capabilities.Streams (the ability to send and receive streaming bodies) or sttp.capabilities.WebSockets (the ability to handle websocket requests).
- trait EndpointErrorOutputVariantsOps[A, I, E, O, -R] extends AnyRef
- trait EndpointErrorOutputsOps[A, I, E, O, -R] extends EndpointErrorOutputsMacros[A, I, E, O, R]
- sealed trait EndpointIO[T] extends EndpointInput[T] with EndpointOutput[T]
- case class EndpointInfo(name: Option[String], summary: Option[String], description: Option[String], tags: Vector[String], deprecated: Boolean, docsExtensions: Vector[DocsExtension[_]]) extends Product with Serializable
- trait EndpointInfoOps[-R] extends AnyRef
- sealed trait EndpointInput[T] extends EndpointTransput[T]
- trait EndpointInputsOps[A, I, E, O, -R] extends EndpointInputsMacros[A, I, E, O, R]
- trait EndpointMetaOps extends AnyRef
- sealed trait EndpointOutput[T] extends EndpointTransput[T]
- trait EndpointOutputsOps[A, I, E, O, -R] extends EndpointOutputsMacros[A, I, E, O, R]
- trait EndpointSecurityInputsOps[A, I, E, O, -R] extends EndpointSecurityInputsMacros[A, I, E, O, R]
- trait EndpointServerLogicOps[A, I, E, O, -R] extends AnyRef
-
sealed
trait
EndpointTransput[T] extends EndpointTransputMacros[T]
A transput is EITHER an input, or an output (see: https://ell.stackexchange.com/questions/21405/hypernym-for-input-and-output).
A transput is EITHER an input, or an output (see: https://ell.stackexchange.com/questions/21405/hypernym-for-input-and-output). The transput traits contain common functionality, shared by all inputs and outputs.
Note that implementations of
EndpointIO
can be used BOTH as inputs and outputs.The hierarchy is as follows:
/--->
EndpointInput
>---\EndpointTransput
>--- --->EndpointIO
\--->EndpointOutput
>---/ - case class FieldName(name: String, encodedName: String) extends Product with Serializable
- case class FileRange(file: tapir.TapirFile, range: Option[RangeValue] = None) extends Product with Serializable
-
trait
LowPriorityCodec extends AnyRef
Lower-priority codec implicits, which transform other codecs.
Lower-priority codec implicits, which transform other codecs. For example, when deriving a codec
List[T] <-> Either[A, B]
, given codecsca: T <-> A
andcb: T <-> B
, we want to getlistHead(eitherRight(ca, cb))
, noteitherRight(listHead(ca), listHead(cb))
(although they would function the same). - trait LowPrioritySchema extends AnyRef
-
trait
Mapping[L, H] extends AnyRef
A bi-directional mapping between values of type
L
and values of typeH
.A bi-directional mapping between values of type
L
and values of typeH
.Low-level values of type
L
can be **decoded** to a higher-level value of typeH
. The decoding can fail; this is represented by a result of type DecodeResult.Failure. Failures might occur due to format errors, wrong arity, exceptions, or validation errors. Validators can be added through thevalidate
method.High-level values of type
H
can be **encoded** as a low-level value of typeL
.Mappings can be chained using one of the
map
functions.- L
The type of the low-level value.
- H
The type of the high-level value.
- case class MultipartCodec[T](rawBodyType: MultipartBody, codec: Codec[Seq[RawPart], T, MultipartFormData]) extends Product with Serializable
-
case class
PartCodec[R, T](rawBodyType: RawBodyType[R], codec: Codec[List[R], T, _ <: CodecFormat]) extends Product with Serializable
Information needed to read a single part of a multipart body: the raw type (
rawBodyType
), and the codec which further decodes it. - type PublicEndpoint[I, E, O, -R] = Endpoint[Unit, I, E, O, R]
- case class RangeValue(start: Option[Long], end: Option[Long], fileSize: Long) extends Product with Serializable
-
sealed
trait
RawBodyType[R] extends AnyRef
The raw format of the body: what do we need to know, to read it and pass to a codec for further decoding.
- type RawPart = Part[_]
-
case class
Schema[T](schemaType: SchemaType[T], name: Option[SName] = None, isOptional: Boolean = false, description: Option[String] = None, default: Option[(T, Option[Any])] = None, format: Option[String] = None, encodedExample: Option[Any] = None, deprecated: Boolean = false, validator: Validator[T] = Validator.pass[T]) extends SchemaMacros[T] with Product with Serializable
Describes the type
T
: its low-level representation, meta-data and validation rules.Describes the type
T
: its low-level representation, meta-data and validation rules.- format
The name of the format of the low-level representation of
T
.
- Annotations
- @implicitNotFound( ... )
-
sealed
trait
SchemaType[T] extends AnyRef
The type of the low-level representation of a
T
values.The type of the low-level representation of a
T
values. Part of Schemas. - case class StreamBodyIO[BS, T, S](streams: Streams[S], codec: Codec[BS, T, CodecFormat], info: Info[T], charset: Option[Charset]) extends Basic[T] with Product with Serializable
- trait Tapir extends TapirExtensions with TapirComputedInputs with TapirStaticContentEndpoints with ModifyMacroSupport
-
final
class
WebSocketBodyBuilder[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat] extends AnyRef
- Definition Classes
- Tapir
-
trait
TapirAliases extends AnyRef
Mixin containing aliases for top-level types and modules in the tapir package.
- trait TapirComputedInputs extends AnyRef
- trait TapirExtensions extends AnyRef
-
type
TapirFile = File
- Definition Classes
- TapirExtensions
- class UnsupportedWebSocketFrameException extends WebSocketException
- sealed trait ValidationError[T] extends AnyRef
- sealed trait Validator[T] extends AnyRef
- case class WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S](streams: Streams[S], requests: Codec[WebSocketFrame, REQ, CodecFormat], responses: Codec[WebSocketFrame, RESP, CodecFormat], codec: Codec[PIPE_REQ_RESP, T, CodecFormat], info: Info[T], requestsInfo: Info[REQ], responsesInfo: Info[RESP], concatenateFragmentedFrames: Boolean, ignorePong: Boolean, autoPongOnPing: Boolean, decodeCloseRequests: Boolean, decodeCloseResponses: Boolean, autoPing: Option[(FiniteDuration, Ping)]) extends Basic[T] with Product with Serializable
- class WebSocketFrameDecodeFailure extends WebSocketException
-
implicit
class
ModifyEach[F[_], T] extends AnyRef
- Definition Classes
- ModifyMacroFunctorSupport
-
trait
ModifyFunctor[F[_], A] extends AnyRef
- Definition Classes
- ModifyMacroFunctorSupport
-
implicit
class
ModifyEachMap[F[_, _], K, T] extends AnyRef
- Definition Classes
- ModifyMacroSupport
-
trait
ModifyMapAtFunctor[F[_, _], K, T] extends AnyRef
- Definition Classes
- ModifyMacroSupport
Value Members
-
def
anyFromStringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF], charset: Charset): Body[String, T]
A body in any format, read using the given
codec
, from a raw string read usingcharset
.A body in any format, read using the given
codec
, from a raw string read usingcharset
.- Definition Classes
- Tapir
-
def
anyFromUtf8StringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF]): Body[String, T]
A body in any format, read using the given
codec
, from a raw string read using UTF-8.A body in any format, read using the given
codec
, from a raw string read using UTF-8.- Definition Classes
- Tapir
-
def
auth: TapirAuth.type
Inputs which describe authentication credentials with metadata.
Inputs which describe authentication credentials with metadata.
- Definition Classes
- Tapir
-
def
binaryBody[R, T](implicit arg0: Binary[R], arg1: Codec[R, T, OctetStream]): Body[R, T]
- Definition Classes
- Tapir
-
def
byteArrayBody: Body[Array[Byte], Array[Byte]]
- Definition Classes
- Tapir
-
def
byteBufferBody: Body[ByteBuffer, ByteBuffer]
- Definition Classes
- Tapir
-
def
clientIp: EndpointInput[Option[String]]
- Definition Classes
- TapirComputedInputs
-
def
cookie[T](name: String)(implicit arg0: Codec[Option[String], T, TextPlain]): Cookie[T]
- Definition Classes
- Tapir
-
def
cookies: Header[List[Cookie]]
- Definition Classes
- Tapir
-
def
customJsonBody[T](implicit arg0: JsonCodec[T]): Body[String, T]
Requires an implicit Codec.JsonCodec in scope.
Requires an implicit Codec.JsonCodec in scope. Such a codec can be created using Codec.json.
However, json codecs are usually derived from json-library-specific implicits. That's why integrations with various json libraries define
jsonBody
methods, which directly require the library-specific implicits.Unless you have defined a custom json codec, the
jsonBody
methods should be used.- Definition Classes
- Tapir
-
val
emptyOutput: Empty[Unit]
An empty output.
An empty output.
- Definition Classes
- Tapir
-
def
emptyOutputAs[T](value: T): Basic[T]
An empty output.
-
val
endpoint: PublicEndpoint[Unit, Unit, Unit, Any]
- Definition Classes
- Tapir
-
def
extractFromRequest[T](f: (ServerRequest) ⇒ T): ExtractFromRequest[T]
Extract a value from a server request.
Extract a value from a server request. This input is only used by server interpreters, it is ignored by documentation interpreters and the provided value is discarded by client interpreters.
- Definition Classes
- Tapir
-
def
fileBody: Body[FileRange, TapirFile]
- Definition Classes
- Tapir
-
def
fileGetServerEndpoint[F[_]](path: EndpointInput[Unit])(systemPath: String): ServerEndpoint[Any, F]
A server endpoint, which exposes a single file from local storage found at
systemPath
, using the givenpath
.A server endpoint, which exposes a single file from local storage found at
systemPath
, using the givenpath
.fileGetServerEndpoint("static" / "hello.html")("/home/app/static/data.html")
- Definition Classes
- TapirStaticContentEndpoints
-
def
fileRangeBody: Body[FileRange, FileRange]
- Definition Classes
- Tapir
-
def
fileServerEndpoints[F[_]](prefix: EndpointInput[Unit])(systemPath: String): List[ServerEndpoint[Any, F]]
Create pair of endpoints (head, get) for particular file
Create pair of endpoints (head, get) for particular file
- Definition Classes
- TapirStaticContentEndpoints
-
def
filesGetEndpoint(prefix: EndpointInput[Unit]): PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[FileRange], Any]
- Definition Classes
- TapirStaticContentEndpoints
-
def
filesGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String): ServerEndpoint[Any, F]
A server endpoint, which exposes files from local storage found at
systemPath
, using the givenprefix
.A server endpoint, which exposes files from local storage found at
systemPath
, using the givenprefix
. Typically, the prefix is a path, but it can also contain other inputs. For example:filesGetServerEndpoint("static" / "files")("/home/app/static")
A request to
/static/files/css/styles.css
will try to read the/home/app/static/css/styles.css
file.- Definition Classes
- TapirStaticContentEndpoints
-
def
filesHeadServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String): ServerEndpoint[Any, F]
A server endpoint, used to verify if sever supports range requests for file under particular path Additionally it verify file existence and returns its size
A server endpoint, used to verify if sever supports range requests for file under particular path Additionally it verify file existence and returns its size
- Definition Classes
- TapirStaticContentEndpoints
-
def
formBody[T](charset: Charset)(implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
- Definition Classes
- Tapir
-
def
formBody[T](implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
- Definition Classes
- Tapir
-
def
header(name: String, value: String): FixedHeader[Unit]
- Definition Classes
- Tapir
-
def
header(h: Header): FixedHeader[Unit]
- Definition Classes
- Tapir
-
def
header[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Header[T]
- Definition Classes
- Tapir
-
def
headers: Headers[List[Header]]
- Definition Classes
- Tapir
-
val
htmlBodyUtf8: Body[String, String]
- Definition Classes
- Tapir
-
val
infallibleEndpoint: PublicEndpoint[Unit, Nothing, Unit, Any]
- Definition Classes
- Tapir
-
def
inputStreamBody: Body[InputStream, InputStream]
- Definition Classes
- Tapir
-
def
isWebSocket: EndpointInput[Boolean]
- Definition Classes
- TapirComputedInputs
-
implicit
def
mapModifyFunctor[M[KT, TT] <: Map[KT, TT], K, T](implicit cbf: CanBuildFrom[M[K, T], (K, T), M[K, T]]): ModifyMapAtFunctor[M, K, T]
- Definition Classes
- ModifyMacroSupport
-
def
multipartBody[T](implicit multipartCodec: MultipartCodec[T]): Body[Seq[RawPart], T]
- Definition Classes
- Tapir
-
val
multipartBody: Body[Seq[RawPart], Seq[Part[Array[Byte]]]]
- Definition Classes
- Tapir
-
def
oneOf[T](firstVariant: OneOfVariant[_ <: T], otherVariants: OneOfVariant[_ <: T]*): OneOf[T, T]
An output which contains a number of variant outputs.
An output which contains a number of variant outputs.
All possible outputs must have a common supertype (
T
). Typically, the supertype is a sealed trait, and the variants are implementing case classes.When encoding to a response, the first matching output is chosen, using the following rules:
- the variant's
appliesTo
method, applied to the output value (as returned by the server logic) must returntrue
. - when a fixed content type is specified by the output, it must match the request's
Accept
header (if present). This implements content negotiation.
When decoding from a response, the first output which decodes successfully is chosen.
The outputs might vary in status codes, headers (e.g. different content types), and body implementations. However, for bodies, only replayable ones can be used, and they need to have the same raw representation (e.g. all byte-array-base, or all file-based).
Note that exhaustiveness of the variants (that all subtypes of
T
are covered) is not checked.- Definition Classes
- Tapir
- the variant's
-
def
oneOfDefaultVariant[T](output: EndpointOutput[T]): OneOfVariant[T]
Create a fallback variant to be used in oneOf output descriptions.
-
def
oneOfVariant[T](code: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T], arg1: ErasureSameAsType[T]): OneOfVariant[T]
Create a one-of-variant which uses
output
if the class of the provided value (when interpreting as a server) matches the runtime class ofT
.Create a one-of-variant which uses
output
if the class of the provided value (when interpreting as a server) matches the runtime class ofT
. Adds a fixed status-code output with the given value.This will fail at compile-time if the type erasure of
T
is different fromT
, as a runtime check in this situation would give invalid results. In such cases, use oneOfVariantClassMatcher, oneOfVariantValueMatcher or oneOfVariantFromMatchType instead.Should be used in oneOf output descriptions.
- Definition Classes
- Tapir
-
def
oneOfVariant[T](output: EndpointOutput[T])(implicit arg0: ClassTag[T], arg1: ErasureSameAsType[T]): OneOfVariant[T]
Create a one-of-variant which uses
output
if the class of the provided value (when interpreting as a server) matches the runtime class ofT
.Create a one-of-variant which uses
output
if the class of the provided value (when interpreting as a server) matches the runtime class ofT
.This will fail at compile-time if the type erasure of
T
is different fromT
, as a runtime check in this situation would give invalid results. In such cases, use oneOfVariantClassMatcher, oneOfVariantValueMatcher or oneOfVariantFromMatchType instead.Should be used in oneOf output descriptions.
- Definition Classes
- Tapir
-
def
oneOfVariantClassMatcher[T](code: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfVariant[T]
Create a one-of-variant which uses
output
i the class of the provided value (when interpreting as a server) matches the givenruntimeClass
.Create a one-of-variant which uses
output
i the class of the provided value (when interpreting as a server) matches the givenruntimeClass
. Note that this does not take into account type erasure. Adds a fixed status-code output with the given value.Should be used in oneOf output descriptions.
- Definition Classes
- Tapir
-
def
oneOfVariantClassMatcher[T](output: EndpointOutput[T], runtimeClass: Class[_]): OneOfVariant[T]
Create a one-of-variant which uses
output
if the class of the provided value (when interpreting as a server) matches the givenruntimeClass
. -
def
oneOfVariantExactMatcher[T](code: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfVariant[T]
Create a one-of-variant which uses
output
if the provided value exactly matches one of the values provided in the second argument list. -
def
oneOfVariantExactMatcher[T](output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfVariant[T]
Create a one-of-variant which
output
if the provided value exactly matches one of the values provided in the second argument list. -
def
oneOfVariantFromMatchType[T](code: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfVariant[T]
Experimental!
Experimental!
Create a one-of-variant which uses
output
if the provided value matches the target type, as checked by MatchType. Instances of MatchType are automatically derived and recursively check that classes of all fields match, to bypass issues caused by type erasure. Adds a fixed status-code output with the given value.Should be used in oneOf output descriptions.
- Definition Classes
- Tapir
-
def
oneOfVariantFromMatchType[T](output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfVariant[T]
Experimental!
Experimental!
Create a one-of-variant which uses
output
if the provided value matches the target type, as checked by MatchType. Instances of MatchType are automatically derived and recursively check that classes of all fields match, to bypass issues caused by type erasure.Should be used in oneOf output descriptions.
- Definition Classes
- Tapir
-
def
oneOfVariantValueMatcher[T](code: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfVariant[T]
Create a one-of-variant which uses
output
if the provided value (when interpreting as a server matches thematcher
predicate. -
def
oneOfVariantValueMatcher[T](output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfVariant[T]
Create a one-of-variant which uses
output
if the provided value (when interpreting as a server matches thematcher
predicate. -
implicit
def
optionModifyFunctor[A]: ModifyFunctor[Option, A]
- Definition Classes
- ModifyMacroFunctorSupport
-
def
path[T](name: String)(implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
- Definition Classes
- Tapir
-
def
path[T](implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
- Definition Classes
- Tapir
-
def
pathBody: Body[FileRange, Path]
- Definition Classes
- TapirExtensions
-
def
paths: PathsCapture[List[String]]
- Definition Classes
- Tapir
-
def
plainBody[T](charset: Charset)(implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
- Definition Classes
- Tapir
-
def
plainBody[T](implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
- Definition Classes
- Tapir
-
def
query[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Query[T]
- Definition Classes
- Tapir
-
def
queryParams: QueryParams[QueryParams]
- Definition Classes
- Tapir
-
def
rawBinaryBody[R](implicit arg0: Binary[R], codec: Codec[R, R, OctetStream]): Body[R, R]
- Definition Classes
- Tapir
-
def
resourceGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePath: String, useGzippedIfAvailable: Boolean = false): ServerEndpoint[Any, F]
A server endpoint, which exposes a single resource available from the given
classLoader
atresourcePath
, using the givenpath
.A server endpoint, which exposes a single resource available from the given
classLoader
atresourcePath
, using the givenpath
.resourceGetServerEndpoint("static" / "hello.html")(classOf[App].getClassLoader, "app/data.html")
- Definition Classes
- TapirStaticContentEndpoints
-
def
resourcesGetEndpoint(prefix: EndpointInput[Unit]): PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[InputStream], Any]
- Definition Classes
- TapirStaticContentEndpoints
-
def
resourcesGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePrefix: String, useGzippedIfAvailable: Boolean = false): ServerEndpoint[Any, F]
A server endpoint, which exposes resources available from the given
classLoader
, using the givenprefix
.A server endpoint, which exposes resources available from the given
classLoader
, using the givenprefix
. Typically, the prefix is a path, but it can also contain other inputs. For example:resourcesGetServerEndpoint("static" / "files")(classOf[App].getClassLoader, "app")
A request to
/static/files/css/styles.css
will try to read the/app/css/styles.css
resource.- Definition Classes
- TapirStaticContentEndpoints
-
def
setCookie(name: String): Header[CookieValueWithMeta]
- Definition Classes
- Tapir
-
def
setCookieOpt(name: String): Header[Option[CookieValueWithMeta]]
- Definition Classes
- Tapir
-
def
setCookies: Header[List[CookieWithMeta]]
- Definition Classes
- Tapir
-
def
statusCode(statusCode: StatusCode): FixedStatusCode[Unit]
An fixed status code output.
An fixed status code output.
- Definition Classes
- Tapir
-
def
statusCode: StatusCode[StatusCode]
An output which maps to the status code in the response.
An output which maps to the status code in the response.
- Definition Classes
- Tapir
-
def
streamBinaryBody[S](s: Streams[S]): StreamBodyIO[BinaryStream, BinaryStream, S]
Creates a stream body with a binary schema.
Creates a stream body with a binary schema. The
application/octet-stream
media type will be used by default, but can be later overridden by providing a customContent-Type
header value.- s
A supported streams implementation.
- Definition Classes
- Tapir
-
def
streamBody[S, T](s: Streams[S])(schema: Schema[T], format: CodecFormat, charset: Option[Charset] = None): StreamBodyIO[BinaryStream, BinaryStream, S]
Creates a stream body with a text schema.
Creates a stream body with a text schema.
- s
A supported streams implementation.
- schema
Schema of the body. This should be a schema for the "deserialized" stream.
- format
The media type to use by default. Can be later overridden by providing a custom
Content-Type
header.- charset
An optional charset of the resulting stream's data, to be used in the content type.
- Definition Classes
- Tapir
-
def
streamTextBody[S](s: Streams[S])(format: CodecFormat, charset: Option[Charset] = None): StreamBodyIO[BinaryStream, BinaryStream, S]
Creates a stream body with a text schema.
Creates a stream body with a text schema.
- s
A supported streams implementation.
- format
The media type to use by default. Can be later overridden by providing a custom
Content-Type
header.- charset
An optional charset of the resulting stream's data, to be used in the content type.
- Definition Classes
- Tapir
-
def
stringBody(charset: Charset): Body[String, String]
- Definition Classes
- Tapir
-
def
stringBody(charset: String): Body[String, String]
- Definition Classes
- Tapir
-
def
stringBody: Body[String, String]
- Definition Classes
- Tapir
-
implicit
def
stringToPath(s: String): FixedPath[Unit]
- Definition Classes
- Tapir
-
implicit
def
traversableModifyFunctor[F[_], A](implicit cbf: CanBuildFrom[F[A], A, F[A]], ev: (F[A]) ⇒ TraversableLike[A, F[A]]): ModifyFunctor[F, A]
- Definition Classes
- ModifyMacroSupport
-
def
webSocketBody[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat]: WebSocketBodyBuilder[REQ, REQ_CF, RESP, RESP_CF]
- REQ
The type of messages that are sent to the server.
- REQ_CF
The codec format (media type) of messages that are sent to the server.
- RESP
The type of messages that are received from the server.
- RESP_CF
The codec format (media type) of messages that are received from the server.
- Definition Classes
- Tapir
-
def
webSocketBodyRaw[S](s: Streams[S]): WebSocketBodyOutput[Pipe[WebSocketFrame, WebSocketFrame], WebSocketFrame, WebSocketFrame, Pipe[WebSocketFrame, WebSocketFrame], S]
- Definition Classes
- Tapir
-
def
xmlBody[T](implicit arg0: XmlCodec[T]): Body[String, T]
Requires an implicit Codec.XmlCodec in scope.
Requires an implicit Codec.XmlCodec in scope. Such a codec can be created using Codec.xml.
- Definition Classes
- Tapir
- object Codec extends CodecExtensions with FormCodecMacros with CodecMacros with LowPriorityCodec
- object CodecFormat
- object DecodeResult
- object Defaults
- object DocsExtension extends Serializable
- object EndpointIO
- object EndpointInput extends EndpointInputMacros
- object EndpointOutput extends EndpointOutputMacros
- object EndpointTransput
- object FieldName extends Serializable
- object Mapping
- object MultipartCodec extends MultipartCodecMacros with Serializable
- object RawBodyType
- object RenderPathTemplate
- object Schema extends LowPrioritySchema with SchemaCompanionMacros with Serializable
- object SchemaType
- object TapirAuth
- object ValidationError
- object Validator extends ValidatorMacros
Deprecated Value Members
-
def
anyJsonBody[T](implicit arg0: JsonCodec[T]): Body[String, T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.18.0) Use customJsonBody
-
def
oneOfDefaultMapping[T](output: EndpointOutput[T]): OneOfVariant[T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Use oneOfDefaultVariant
-
def
oneOfMapping[T](code: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T], arg1: ErasureSameAsType[T]): OneOfVariant[T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Use oneOfVariant
-
def
oneOfMappingClassMatcher[T](code: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfVariant[T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Use oneOfVariantClassMatcher
-
def
oneOfMappingExactMatcher[T](code: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfVariant[T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Use oneOfVariantExactMatcher
-
def
oneOfMappingFromMatchType[T](code: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfVariant[T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Use oneOfVariantFromMatchType
-
def
oneOfMappingValueMatcher[T](code: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfVariant[T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Use oneOfVariantValueMatcher