trait Tapir extends TapirExtensions with TapirComputedInputs with TapirStaticContentEndpoints with ModifyMacroSupport

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tapir
  2. ModifyMacroSupport
  3. ModifyMacroFunctorSupport
  4. TapirStaticContentEndpoints
  5. TapirComputedInputs
  6. TapirExtensions
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class BinaryBodyPartiallyApplied[R] extends AnyRef
  2. type TapirFile = File
    Definition Classes
    TapirExtensions
  3. final class WebSocketBodyBuilder[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat] extends AnyRef
  4. implicit class ModifyEach[F[_], T] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  5. trait ModifyFunctor[F[_], A] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  6. implicit class ModifyEachMap[F[_, _], K, T] extends AnyRef
    Definition Classes
    ModifyMacroSupport

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. 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 using charset.

  5. 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.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def auth: TapirAuth.type

    Inputs which describe authentication credentials with metadata.

  8. def binaryBody[R](rbt: Binary[R]): BinaryBodyPartiallyApplied[R]

    Usage:

    Usage: 

    binaryBody(RawBodyType.FileBody)[MyType]

    , given that a codec between a file and MyType is available in the implicit scope.

    binaryBody(RawBodyType.FileBody)[MyType] }}} scope.

  9. def byteArrayBody: Body[Array[Byte], Array[Byte]]
  10. def byteBufferBody: Body[ByteBuffer, ByteBuffer]
  11. def clientIp: EndpointInput[Option[String]]
    Definition Classes
    TapirComputedInputs
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  13. def cookie[T](name: String)(implicit arg0: Codec[Option[String], T, TextPlain]): Cookie[T]
  14. def cookies: Header[List[Cookie]]
  15. 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.

  16. val emptyInput: EndpointInput[Unit]
  17. val emptyOutput: Empty[Unit]

    An empty output.

  18. def emptyOutputAs[T](value: T): Atom[T]

    An empty output.

    An empty output. Useful if one of the oneOf branches of a coproduct type is a case object that should be mapped to an empty body.

  19. val endpoint: PublicEndpoint[Unit, Unit, Unit, Any]
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. 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.

  23. def fileBody: Body[FileRange, TapirFile]
  24. def fileGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String): ServerEndpoint[Any, F]

    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.

    fileGetServerEndpoint("static" / "hello.html")("/home/app/static/data.html")
    Definition Classes
    TapirStaticContentEndpoints
  25. def fileRangeBody: Body[FileRange, FileRange]
  26. def filesGetEndpoint(prefix: EndpointInput[Unit]): PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[FileRange], Any]
    Definition Classes
    TapirStaticContentEndpoints
  27. lazy val filesGetEndpoint: PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[FileRange], Any]
    Definition Classes
    TapirStaticContentEndpoints
  28. def filesGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String, options: FilesOptions[F] = FilesOptions.default[F]): ServerEndpoint[Any, F]

    A server endpoint, which exposes files from local storage found at systemPath, using the given prefix.

    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:

    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
  29. def filesHeadServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String, options: FilesOptions[F] = FilesOptions.default[F]): 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
  30. def filesServerEndpoints[F[_]](prefix: EndpointInput[Unit])(systemPath: String, options: FilesOptions[F] = FilesOptions.default[F]): List[ServerEndpoint[Any, F]]

    Create a pair of endpoints (head, get) for exposing files from local storage found at systemPath, using the given prefix.

    Create a pair of endpoints (head, get) for exposing 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:

    filesServerEndpoints("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
  31. def formBody[T](charset: Charset)(implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
  32. def formBody[T](implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
  33. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. def header(name: String, value: String): FixedHeader[Unit]
  36. def header(h: Header): FixedHeader[Unit]
  37. def header[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Header[T]
  38. def headers: Headers[List[Header]]
  39. val htmlBodyUtf8: Body[String, String]
  40. val infallibleEndpoint: PublicEndpoint[Unit, Nothing, Unit, Any]
  41. def inputStreamBody: Body[InputStream, InputStream]
  42. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  43. def isWebSocket: EndpointInput[Boolean]
    Definition Classes
    TapirComputedInputs
  44. def multipartBody[T](implicit multipartCodec: MultipartCodec[T]): Body[Seq[RawPart], T]
  45. val multipartBody: Body[Seq[RawPart], Seq[Part[Array[Byte]]]]
  46. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. val noTrailingSlash: EndpointInput[Unit]

    An input which matches if the request URI ends with a trailing slash, otherwise the result is a decode failure on the path.

    An input which matches if the request URI ends with a trailing slash, otherwise the result is a decode failure on the path. Has no effect when used by documentation or client interpreters.

    Definition Classes
    TapirComputedInputs
  48. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  49. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  50. 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. Each variant can contain different outputs and represent different content. To describe an output which represents same content, but with different content types, use oneOfBody.

    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:

    1. the variant's appliesTo method, applied to the output value (as returned by the server logic) must return true.
    2. 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.

  51. def oneOfBody[T](first: (ContentTypeRange, Body[_, T]), others: (ContentTypeRange, Body[_, T])*): OneOfBody[T, T]

    See oneOfBody.

    See oneOfBody.

    Allows explicitly specifying the content type range, for which each body will be used, instead of defaulting to the exact media type as specified by the body's codec. This is only used when choosing which body to decode.

  52. def oneOfBody[T](first: Body[_, T], others: Body[_, T]*): OneOfBody[T, T]

    A body input or output, which can be one of the given variants.

    A body input or output, which can be one of the given variants. All variants should represent T instances using different content types. Hence, the content type is used as a discriminator to choose the appropriate variant.

    Should be used to describe an input or output which represents the same content, but using different content types. For an output which describes variants including possibly different outputs (representing different content), see oneOf.

    The server behavior is as follows:

    • when encoding to a response, the first variant matching the request's Accept header is chosen (if present). Otherwise, the first variant is used. This implements content negotiation.
    • when decoding a request, the variant corresponding to the request's Content-Type header is chosen (if present). Otherwise, a decode failure is returned, which by default results in an 415 Unsupported Media Type response.

    The client behavior is as follows:

    • when encoding a request, the first variant is used.
    • when decoding a response, the variant corresponding to the response's Content-Type header is chosen (if present). Otherwise, the first variant is used. For client interpreters to work correctly, all body variants must have the same raw type (e.g. all are string-based or all byte-array-based)

    All possible bodies must have the same type T. Typically, the bodies will vary in the Codecs that are used for the body.

  53. def oneOfDefaultVariant[T](output: EndpointOutput[T]): OneOfVariant[T]

    Create a fallback variant to be used in oneOf output descriptions.

    Create a fallback variant to be used in oneOf output descriptions. Multiple such variants can be specified, with different body content types.

  54. 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 of 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 of T. Adds a fixed status-code output with the given value.

    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 oneOfVariantClassMatcher, oneOfVariantValueMatcher or oneOfVariantFromMatchType instead.

    Should be used in oneOf output descriptions.

  55. 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 of 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 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 oneOfVariantClassMatcher, oneOfVariantValueMatcher or oneOfVariantFromMatchType instead.

    Should be used in oneOf output descriptions.

  56. 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 given runtimeClass.

    Create a one-of-variant which uses output i 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. Adds a fixed status-code output with the given value.

    Should be used in oneOf output descriptions.

  57. 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 given runtimeClass.

    Create a one-of-variant which uses 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.

  58. 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.

    Create a one-of-variant which uses output if the provided value exactly matches one of the values provided in the second argument list. Adds a fixed status-code output with the given value.

    Should be used in oneOf output descriptions.

  59. 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.

    Create a one-of-variant which output if the provided value exactly matches one of the values provided in the second argument list.

    Should be used in oneOf output descriptions.

  60. 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.

  61. 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.

  62. 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 the matcher predicate.

    Create a one-of-variant which uses output if the provided value (when interpreting as a server matches the matcher predicate. Adds a fixed status-code output with the given value.

    Should be used in oneOf output descriptions.

  63. 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 the matcher predicate.

    Create a one-of-variant which uses output if the provided value (when interpreting as a server matches the matcher predicate.

    Should be used in oneOf output descriptions.

  64. implicit def optionModifyFunctor[A]: ModifyFunctor[Option, A]
    Definition Classes
    ModifyMacroFunctorSupport
  65. def path[T](name: String)(implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
  66. def path[T](implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
  67. def pathBody: Body[FileRange, Path]
    Definition Classes
    TapirExtensions
  68. def paths: PathsCapture[List[String]]
  69. def plainBody[T](charset: Charset)(implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
  70. def plainBody[T](implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
  71. def query[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Query[T]
  72. def queryParams: QueryParams[QueryParams]
  73. def rawBinaryBody[R](rbt: Binary[R])(implicit codec: Codec[R, R, OctetStream]): Body[R, R]
  74. def resourceGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePath: String, options: ResourcesOptions[F] = ResourcesOptions.default[F]): ServerEndpoint[Any, F]

    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.

    resourceGetServerEndpoint("static" / "hello.html")(classOf[App].getClassLoader, "app/data.html")
    Definition Classes
    TapirStaticContentEndpoints
  75. def resourcesGetEndpoint(prefix: EndpointInput[Unit]): PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[InputStream], Any]
    Definition Classes
    TapirStaticContentEndpoints
  76. lazy val resourcesGetEndpoint: PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[InputStream], Any]
    Definition Classes
    TapirStaticContentEndpoints
  77. def resourcesGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePrefix: String, options: ResourcesOptions[F] = ResourcesOptions.default[F]): ServerEndpoint[Any, F]

    A server endpoint, which exposes resources available from the given classLoader, using the given prefix.

    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:

    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
  78. def setCookie(name: String): Header[CookieValueWithMeta]
  79. def setCookieOpt(name: String): Header[Option[CookieValueWithMeta]]
  80. def setCookies: Header[List[CookieWithMeta]]
  81. def statusCode(statusCode: StatusCode): FixedStatusCode[Unit]

    An fixed status code output.

  82. def statusCode: StatusCode[StatusCode]

    An output which maps to the status code in the response.

  83. 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 custom Content-Type header value.

    s

    A supported streams implementation.

  84. 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 the given schema.

    Creates a stream body with the given 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.

  85. 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.

  86. def stringBody(charset: Charset): Body[String, String]
  87. def stringBody(charset: String): Body[String, String]
  88. def stringBody: Body[String, String]
  89. implicit def stringToPath(s: String): FixedPath[Unit]
  90. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  91. def toString(): String
    Definition Classes
    AnyRef → Any
  92. implicit def traversableModifyFunctor[F[_], A](implicit fac: Factory[A, F[A]], ev: (F[A]) => Iterable[A]): ModifyFunctor[F, A]
    Definition Classes
    ModifyMacroSupport
  93. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  94. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  95. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  96. 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.

  97. def webSocketBodyRaw[S](s: Streams[S]): WebSocketBodyOutput[Pipe[WebSocketFrame, WebSocketFrame], WebSocketFrame, WebSocketFrame, Pipe[WebSocketFrame, WebSocketFrame], S]
  98. 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.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from ModifyMacroSupport

Inherited from ModifyMacroFunctorSupport

Inherited from TapirStaticContentEndpoints

Inherited from TapirComputedInputs

Inherited from TapirExtensions

Inherited from AnyRef

Inherited from Any

Ungrouped