package ztapir
- Alphabetic
- By Inheritance
- ztapir
- ZTapir
- Tapir
- ModifyMacroSupport
- ModifyMacroFunctorSupport
- TapirStaticContentEndpoints
- TapirComputedInputs
- TapirExtensions
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
class
BinaryBodyPartiallyApplied[R] extends AnyRef
- Definition Classes
- Tapir
-
implicit
class
ModifyEach[F[_], T] extends AnyRef
- Definition Classes
- ModifyMacroFunctorSupport
-
implicit
class
ModifyEachMap[F[_, _], K, T] extends AnyRef
- Definition Classes
- ModifyMacroSupport
-
trait
ModifyFunctor[F[_], A] extends AnyRef
- Definition Classes
- ModifyMacroFunctorSupport
-
trait
ModifyMapAtFunctor[F[_, _], K, T] extends AnyRef
- Definition Classes
- ModifyMacroSupport
- class RIOMonadError[R] extends MonadError[[β$0$]ZIO[R, Throwable, β$0$]]
-
type
TapirFile = File
- Definition Classes
- TapirExtensions
-
final
class
WebSocketBodyBuilder[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat] extends AnyRef
- Definition Classes
- Tapir
-
case class
ZPartialServerEndpoint[R, SECURITY_INPUT, PRINCIPAL, INPUT, ERROR_OUTPUT, OUTPUT, -C](endpoint: Endpoint[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, C], securityLogic: (SECURITY_INPUT) ⇒ ZIO[R, ERROR_OUTPUT, PRINCIPAL]) extends EndpointInputsOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, C] with EndpointOutputsOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, C] with EndpointErrorOutputVariantsOps[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, C] with EndpointInfoOps[C] with EndpointMetaOps with Product with Serializable
An endpoint with the security logic provided, and the main logic yet unspecified.
An endpoint with the security logic provided, and the main logic yet unspecified. See RichZEndpoint.zServerLogic.
The provided security part of the server logic transforms inputs of type
SECURITY_INPUT
, either to an error of typeERROR_OUTPUT
, or value of typePRINCIPAL
.The part of the server logic which is not provided, will have to transform a tuple:
(PRINCIPAL, INPUT)
either into an error, or a value of typeOUTPUT
.Inputs/outputs can be added to partial endpoints as to regular endpoints, however the shape of the error outputs is fixed and cannot be changed. Hence, it's possible to create a base, secured input, and then specialise it with inputs, outputs and logic as needed.
- SECURITY_INPUT
Type of the security inputs, transformed into PRINCIPAL
- PRINCIPAL
Type of transformed security input.
- INPUT
Input parameter types.
- ERROR_OUTPUT
Error output parameter types.
- OUTPUT
Output parameter types.
- C
The capabilities that are required by this endpoint's inputs/outputs.
Any
, if no requirements.
-
type
ZServerEndpoint[R, -C] = ServerEndpoint[C, [β$0$]ZIO[R, Throwable, β$0$]]
- Definition Classes
- ZTapir
- trait ZTapir extends AnyRef
-
implicit
class
RichZEndpoint[SECURITY_INPUT, INPUT, ERROR_OUTPUT, OUTPUT, C] extends AnyRef
- Definition Classes
- ZTapir
-
implicit
class
RichZServerEndpoint[R, C] extends AnyRef
- Definition Classes
- ZTapir
Value Members
-
def
auth: TapirAuth.type
- Definition Classes
- Tapir
-
def
binaryBody[R](rbt: Binary[R]): BinaryBodyPartiallyApplied[R]
- 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
customCodecJsonBody[T](implicit arg0: JsonCodec[T]): Body[String, T]
- Definition Classes
- Tapir
-
val
emptyAuth: Auth[Unit, ApiKey]
- Definition Classes
- Tapir
-
val
emptyInput: EndpointInput[Unit]
- Definition Classes
- Tapir
-
val
emptyOutput: Atom[Unit]
- Definition Classes
- Tapir
-
def
emptyOutputAs[T](value: T): Atom[T]
- Definition Classes
- Tapir
-
val
endpoint: PublicEndpoint[Unit, Unit, Unit, Any]
- Definition Classes
- Tapir
-
def
extractFromRequest[T](f: (ServerRequest) ⇒ T): ExtractFromRequest[T]
- Definition Classes
- Tapir
-
def
fileBody: Body[FileRange, TapirFile]
- Definition Classes
- Tapir
-
def
fileRangeBody: Body[FileRange, FileRange]
- Definition Classes
- Tapir
-
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
inputStreamRangeBody: Body[InputStreamRange, InputStreamRange]
- 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
-
val
noTrailingSlash: EndpointInput[Unit]
- Definition Classes
- TapirComputedInputs
-
def
oneOf[T](firstVariant: OneOfVariant[_ <: T], otherVariants: OneOfVariant[_ <: T]*): OneOf[T, T]
- Definition Classes
- Tapir
-
def
oneOfBody[T](first: (ContentTypeRange, StreamBodyWrapper[_, T]), second: (ContentTypeRange, StreamBodyWrapper[_, T]), others: (ContentTypeRange, StreamBodyWrapper[_, T])*): OneOfBody[T, T]
- Definition Classes
- Tapir
-
def
oneOfBody[T](first: (ContentTypeRange, Body[_, T]), others: (ContentTypeRange, Body[_, T])*): OneOfBody[T, T]
- Definition Classes
- Tapir
-
def
oneOfBody[T](first: StreamBodyWrapper[_, T], others: StreamBodyWrapper[_, T]*): OneOfBody[T, T]
- Definition Classes
- Tapir
-
def
oneOfBody[T](first: Body[_, T], others: Body[_, T]*): OneOfBody[T, T]
- Definition Classes
- Tapir
-
def
oneOfDefaultVariant[T](output: EndpointOutput[T]): OneOfVariant[T]
- Definition Classes
- Tapir
-
def
oneOfVariant[T](code: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T], arg1: ErasureSameAsType[T]): OneOfVariant[T]
- Definition Classes
- Tapir
-
def
oneOfVariant[T](output: EndpointOutput[T])(implicit arg0: ClassTag[T], arg1: ErasureSameAsType[T]): OneOfVariant[T]
- Definition Classes
- Tapir
-
def
oneOfVariantClassMatcher[T](code: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfVariant[T]
- Definition Classes
- Tapir
-
def
oneOfVariantClassMatcher[T](output: EndpointOutput[T], runtimeClass: Class[_]): OneOfVariant[T]
- Definition Classes
- Tapir
-
def
oneOfVariantExactMatcher[T](code: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfVariant[T]
- Definition Classes
- Tapir
-
def
oneOfVariantExactMatcher[T](output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfVariant[T]
- Definition Classes
- Tapir
-
def
oneOfVariantFromMatchType[T](code: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfVariant[T]
- Definition Classes
- Tapir
-
def
oneOfVariantFromMatchType[T](output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfVariant[T]
- Definition Classes
- Tapir
-
def
oneOfVariantValueMatcher[T](code: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfVariant[T]
- Definition Classes
- Tapir
-
def
oneOfVariantValueMatcher[T](output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfVariant[T]
- Definition Classes
- Tapir
-
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
queryAnyFormat[T, CF <: CodecFormat](name: String, codec: Codec[List[String], T, CF]): Query[T]
- Definition Classes
- Tapir
-
def
queryParams: QueryParams[QueryParams]
- Definition Classes
- Tapir
-
def
rawBinaryBody[R](rbt: Binary[R])(implicit codec: Codec[R, R, OctetStream]): Body[R, R]
- Definition Classes
- Tapir
-
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]
- Definition Classes
- Tapir
-
def
statusCode: StatusCode[StatusCode]
- Definition Classes
- Tapir
-
def
streamBinaryBody[S](s: Streams[S])(format: CodecFormat): StreamBodyIO[BinaryStream, BinaryStream, S]
- Definition Classes
- Tapir
-
def
streamBody[S, T](s: Streams[S])(schema: Schema[T], format: CodecFormat, charset: Option[Charset]): StreamBodyIO[BinaryStream, BinaryStream, S]
- Definition Classes
- Tapir
-
def
streamTextBody[S](s: Streams[S])(format: CodecFormat, charset: Option[Charset]): StreamBodyIO[BinaryStream, BinaryStream, S]
- 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
-
def
stringBodyAnyFormat[T, CF <: CodecFormat](codec: Codec[String, T, CF], charset: Charset): Body[String, T]
- Definition Classes
- Tapir
-
def
stringBodyUtf8AnyFormat[T, CF <: CodecFormat](codec: Codec[String, T, CF]): Body[String, T]
- Definition Classes
- Tapir
-
def
stringJsonBody(charset: Charset): Body[String, String]
- Definition Classes
- Tapir
-
def
stringJsonBody: 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]
- 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]
- Definition Classes
- Tapir
- object ZioServerSentEvents
Deprecated Value Members
-
def
fileGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String): ServerEndpoint[Any, F]
- Definition Classes
- TapirStaticContentEndpoints
- Annotations
- @deprecated
- Deprecated
(Since version 1.3.0) Use sttp.tapir.files.staticFileGetServerEndpoint
-
def
filesGetEndpoint(prefix: EndpointInput[Unit]): PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[FileRange], Any]
- Definition Classes
- TapirStaticContentEndpoints
- Annotations
- @deprecated
- Deprecated
(Since version 1.3.0) Use sttp.tapir.files.staticFilesGetEndpoint
-
lazy val
filesGetEndpoint: PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[FileRange], Any]
- Definition Classes
- TapirStaticContentEndpoints
- Annotations
- @deprecated
- Deprecated
(Since version 1.3.0) Use sttp.tapir.files.staticFilesGetEndpoint
-
def
filesGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String, options: FilesOptions[F]): ServerEndpoint[Any, F]
- Definition Classes
- TapirStaticContentEndpoints
- Annotations
- @deprecated
- Deprecated
(Since version 1.3.0) Use sttp.tapir.files.staticFilesGetServerEndpoint
-
def
filesHeadServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String, options: FilesOptions[F]): ServerEndpoint[Any, F]
- Definition Classes
- TapirStaticContentEndpoints
- Annotations
- @deprecated
- Deprecated
(Since version 1.3.0) Use sttp.tapir.files.staticFilesHeadServerEndpoint
-
def
filesServerEndpoints[F[_]](prefix: EndpointInput[Unit])(systemPath: String, options: FilesOptions[F]): List[ServerEndpoint[Any, F]]
- Definition Classes
- TapirStaticContentEndpoints
- Annotations
- @deprecated
- Deprecated
(Since version 1.3.0) Use sttp.tapir.files.staticFilesServerEndpoints
-
def
resourceGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePath: String, options: ResourcesOptions[F]): ServerEndpoint[Any, F]
- Definition Classes
- TapirStaticContentEndpoints
- Annotations
- @deprecated
- Deprecated
(Since version 1.3.0) Use sttp.tapir.files.staticResourceGetServerEndpoint
-
def
resourcesGetEndpoint(prefix: EndpointInput[Unit]): PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[InputStream], Any]
- Definition Classes
- TapirStaticContentEndpoints
- Annotations
- @deprecated
- Deprecated
(Since version 1.3.0) Use sttp.tapir.files.staticResourcesGetEndpoint
-
lazy val
resourcesGetEndpoint: PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[InputStream], Any]
- Definition Classes
- TapirStaticContentEndpoints
- Annotations
- @deprecated
- Deprecated
(Since version 1.3.0) Use sttp.tapir.files.staticResourcesGetEndpoint
-
def
resourcesGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePrefix: String, options: ResourcesOptions[F]): ServerEndpoint[Any, F]
- Definition Classes
- TapirStaticContentEndpoints
- Annotations
- @deprecated
- Deprecated
(Since version 1.3.0) Use sttp.tapir.files.staticResourcesGetServerEndpoint