package tapir
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- tapir
- Tapir
- TapirMacros
- ModifyMacroSupport
- ModifyMacroFunctorSupport
- TapirStaticContentEndpoints
- TapirComputedInputs
- TapirExtensions
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Type Members
- type AnyListCodec = Codec[_ <: List[_], _, _ <: CodecFormat]
- type AnyPart = Part[_]
-
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
- type RawPart = Part[_]
-
type
TapirFile = File
- Definition Classes
- TapirExtensions
-
final
class
WebSocketBodyBuilder[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat] extends AnyRef
- Definition Classes
- Tapir
Value Members
-
def
anyFromStringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF], charset: Charset): Body[String, T]
- Definition Classes
- Tapir
-
def
anyFromUtf8StringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF]): Body[String, T]
- Definition Classes
- Tapir
-
def
auth: TapirAuth.type
- 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]
- Definition Classes
- Tapir
-
val
emptyOutput: Empty[Unit]
- Definition Classes
- Tapir
-
def
emptyOutputAs[T](value: T): Basic[T]
- Definition Classes
- Tapir
-
val
endpoint: Endpoint[Unit, Unit, Unit, Any]
- Definition Classes
- Tapir
-
def
extractFromRequest[T](f: (ServerRequest) ⇒ T): ExtractFromRequest[T]
- Definition Classes
- Tapir
-
def
fileBody: Body[TapirFile, TapirFile]
- Definition Classes
- Tapir
-
def
fileServerEndpoint[F[_]](path: EndpointInput[Unit])(systemPath: String): ServerEndpoint[StaticInput, StaticErrorOutput, StaticOutput[File], Any, F]
- Definition Classes
- TapirStaticContentEndpoints
-
def
filesEndpoint(prefix: EndpointInput[Unit]): Endpoint[StaticInput, StaticErrorOutput, StaticOutput[File], Any]
- Definition Classes
- TapirStaticContentEndpoints
-
def
filesServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String): ServerEndpoint[StaticInput, StaticErrorOutput, StaticOutput[File], Any, F]
- 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: Endpoint[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](firstCase: OneOfMapping[_ <: T], otherCases: OneOfMapping[_ <: T]*): OneOf[T, T]
- Definition Classes
- Tapir
-
def
oneOfDefaultMapping[T](output: EndpointOutput[T]): OneOfMapping[T]
- Definition Classes
- Tapir
-
macro
def
oneOfMapping[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T]): OneOfMapping[T]
- Definition Classes
- TapirMacros
-
def
oneOfMappingClassMatcher[T](statusCode: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfMapping[T]
- Definition Classes
- Tapir
-
def
oneOfMappingExactMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfMapping[T]
- Definition Classes
- Tapir
-
def
oneOfMappingFromMatchType[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfMapping[T]
- Definition Classes
- Tapir
-
def
oneOfMappingValueMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfMapping[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[File, 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
resourceServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePath: String): ServerEndpoint[StaticInput, StaticErrorOutput, StaticOutput[InputStream], Any, F]
- Definition Classes
- TapirStaticContentEndpoints
-
def
resourcesEndpoint(prefix: EndpointInput[Unit]): Endpoint[StaticInput, StaticErrorOutput, StaticOutput[InputStream], Any]
- Definition Classes
- TapirStaticContentEndpoints
-
def
resourcesServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePrefix: String): ServerEndpoint[StaticInput, StaticErrorOutput, StaticOutput[InputStream], Any, F]
- Definition Classes
- TapirStaticContentEndpoints
-
def
setCookie(name: String): Header[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]): 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
-
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
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
statusDefaultMapping[T](output: EndpointOutput[T]): OneOfMapping[T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.18) Use oneOfDefaultMapping
-
macro
def
statusMapping[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T]): OneOfMapping[T]
- Definition Classes
- TapirMacros
- Annotations
- @deprecated
- Deprecated
(Since version 0.18) Use oneOfMapping
-
def
statusMappingClassMatcher[T](statusCode: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfMapping[T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.18) Use oneOfMappingClassMatcher
-
def
statusMappingExactMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfMapping[T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.18) Use oneOfMappingExactMatcher
-
def
statusMappingFromMatchType[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfMapping[T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.18) Use oneOfMappingFromMatchType
-
def
statusMappingValueMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfMapping[T]
- Definition Classes
- Tapir
- Annotations
- @deprecated
- Deprecated
(Since version 0.18) Use oneOfMappingValueMatcher