Tapir
Type members
Classlikes
Inherited types
Value members
Concrete methods
A body in any format, read using the given codec
, from a raw string read using charset
.
A body in any format, read using the given codec
, from a raw string read using charset
.
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.
Requires an implicit Codec.JsonCodec in scope. Such a codec can be created using Codec.json.
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.
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.
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.
Specifies a correspondence between status codes and outputs.
Specifies a correspondence between status codes and outputs.
All outputs must have a common supertype (T
). Typically, the supertype is a sealed trait, and the mappings are
implementing cases classes.
A single status code can have multiple mappings (or there can be multiple default mappings), with different body content types. The mapping can then be chosen based on content type negotiation, or the content type header.
Note that exhaustiveness of the mappings is not checked (that all subtypes of T
are covered).
Create a one-of-mapping which uses statusCode
and output
if the class of the provided value (when interpreting
as a server) matches the given runtimeClass
. Note that this does not take into account type erasure.
Create a one-of-mapping which uses statusCode
and output
if the class of the provided value (when interpreting
as a server) matches the given runtimeClass
. Note that this does not take into account type erasure.
Should be used in oneOf output descriptions.
Create a one-of-mapping which uses statusCode
and output
if the provided value exactly matches one
of the values provided in the second argument list.
Create a one-of-mapping which uses statusCode
and output
if the provided value exactly matches one
of the values provided in the second argument list.
Should be used in oneOf output descriptions.
Experimental!
Experimental!
Create a one-of-mapping which uses statusCode
and 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.
Create a one-of-mapping which uses statusCode
and output
if the provided value (when interpreting as a server
matches the matcher
predicate.
Create a one-of-mapping which uses statusCode
and output
if the provided value (when interpreting as a server
matches the matcher
predicate.
Should be used in oneOf output descriptions.
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 custom Content-Type
header value.
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 custom Content-Type
header value.
- Value Params
- s
A supported streams implementation.
Creates a stream body with a text schema.
Creates a stream body with a text schema.
- Value Params
- charset
An optional charset of the resulting stream's data, to be used in the content type.
- format
The media type to use by default. Can be later overridden by providing a custom
Content-Type
header.- s
A supported streams implementation.
- schema
Schema of the body. This should be a schema for the "deserialized" stream.
Creates a stream body with a text schema.
Creates a stream body with a text schema.
- Value Params
- charset
An optional charset of the resulting stream's data, to be used in the content type.
- format
The media type to use by default. Can be later overridden by providing a custom
Content-Type
header.- s
A supported streams implementation.
- Type Params
- 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.
Requires an implicit Codec.XmlCodec in scope. Such a codec can be created using Codec.xml.
Requires an implicit Codec.XmlCodec in scope. Such a codec can be created using Codec.xml.
Deprecated methods
- Deprecated
[Since version 0.18.0]
Use customJsonBody
- Deprecated
[Since version 0.18]
- Deprecated
[Since version 0.18]
- Deprecated
[Since version 0.18]
- Deprecated
[Since version 0.18]
Inherited methods
A server endpoint, which exposes a single file from local storage found at systemPath
, using the given path
.
A server endpoint, which exposes a single file from local storage found at systemPath
, using the given path
.
fileServerEndpoint("static" / "hello.html")("/home/app/static/data.html")
- Inherited from
- TapirStaticContentEndpoints
- Inherited from
- TapirStaticContentEndpoints
A server endpoint, which exposes files from local storage found at systemPath
, using the given prefix
.
Typically, the prefix is a path, but it can also contain other inputs. For example:
A server endpoint, which exposes files from local storage found at systemPath
, using the given prefix
.
Typically, the prefix is a path, but it can also contain other inputs. For example:
filesServerEndpoint("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.
- Inherited from
- TapirStaticContentEndpoints
Create a one-of-mapping which uses statusCode
and output
if the class of the provided value (when interpreting
as a server) matches the runtime class of T
.
Create a one-of-mapping which uses statusCode
and output
if the class of the provided value (when interpreting
as a server) matches the runtime class of T
.
This will fail at compile-time if the type erasure of T
is different from T
, as a runtime check in this
situation would give invalid results. In such cases, use oneOfMappingClassMatcher,
oneOfMappingValueMatcher or oneOfMappingFromMatchType instead.
Should be used in oneOf output descriptions.
- Inherited from
- TapirMacros
A server endpoint, which exposes a single resource available from the given classLoader
at resourcePath
,
using the given path
.
A server endpoint, which exposes a single resource available from the given classLoader
at resourcePath
,
using the given path
.
resourceServerEndpoint("static" / "hello.html")(classOf[App].getClassLoader, "app/data.html")
- Inherited from
- TapirStaticContentEndpoints
- Inherited from
- TapirStaticContentEndpoints
A server endpoint, which exposes resources available from the given classLoader
, using the given prefix
.
Typically, the prefix is a path, but it can also contain other inputs. For example:
A server endpoint, which exposes resources available from the given classLoader
, using the given prefix
.
Typically, the prefix is a path, but it can also contain other inputs. For example:
resourcesServerEndpoint("static" / "files")(classOf[App].getClassLoader, "app")
A request to /static/files/css/styles.css
will try to read the /app/css/styles.css
resource.
- Inherited from
- TapirStaticContentEndpoints
Deprecated and Inherited methods
- Deprecated
[Since version 0.18]
- Inherited from
- TapirMacros
Implicits
Implicits
Inherited implicits
- Inherited from
- ModifyMacroSupport