trait Tapir extends TapirExtensions with TapirComputedInputs with TapirStaticContentEndpoints with ModifyMacroSupport with TapirMacros

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

Type Members

  1. type TapirFile = File
    Definition Classes
    TapirExtensions
  2. final class WebSocketBodyBuilder[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat] extends AnyRef
  3. implicit class ModifyEach[F[_], T] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  4. trait ModifyFunctor[F[_], A] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  5. 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
  8. def binaryBody[R, T](implicit arg0: Binary[R], arg1: Codec[R, T, OctetStream]): Body[R, T]
  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 emptyOutput: Empty[Unit]

    An empty output.

    An empty output. Useful if one of oneOf branches should be mapped to the status code only.

  17. def emptyOutputAs[T](value: T): Basic[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.

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

  22. def fileBody: Body[TapirFile, TapirFile]
  23. def formBody[T](charset: Charset)(implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
  24. def formBody[T](implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. def header(name: String, value: String): FixedHeader[Unit]
  28. def header(h: Header): FixedHeader[Unit]
  29. def header[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Header[T]
  30. def headers: Headers[List[Header]]
  31. val htmlBodyUtf8: Body[String, String]
  32. val infallibleEndpoint: Endpoint[Unit, Nothing, Unit, Any]
  33. def inputStreamBody: Body[InputStream, InputStream]
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def isWebSocket: EndpointInput[Boolean]
    Definition Classes
    TapirComputedInputs
  36. def multipartBody[T](implicit multipartCodec: MultipartCodec[T]): Body[Seq[RawPart], T]
  37. val multipartBody: Body[Seq[RawPart], Seq[Part[Array[Byte]]]]
  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  41. def oneOf[T](firstCase: OneOfMapping[_ <: T], otherCases: OneOfMapping[_ <: T]*): OneOf[T, T]

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

  42. def oneOfDefaultMapping[T](output: EndpointOutput[T]): OneOfMapping[T]

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

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

  43. macro def oneOfMapping[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T]): OneOfMapping[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.

    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.

    Definition Classes
    TapirMacros
  44. def oneOfMappingClassMatcher[T](statusCode: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfMapping[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 given runtimeClass.

    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.

  45. def oneOfMappingExactMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfMapping[T]

    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.

  46. def oneOfMappingFromMatchType[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfMapping[T]

    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.

  47. def oneOfMappingValueMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfMapping[T]

    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.

  48. implicit def optionModifyFunctor[A]: ModifyFunctor[Option, A]
    Definition Classes
    ModifyMacroFunctorSupport
  49. def path[T](name: String)(implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
  50. def path[T](implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
  51. def paths: PathsCapture[List[String]]
  52. def plainBody[T](charset: Charset)(implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
  53. def plainBody[T](implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
  54. def query[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Query[T]
  55. def queryParams: QueryParams[QueryParams]
  56. def rawBinaryBody[R](implicit arg0: Binary[R], codec: Codec[R, R, OctetStream]): Body[R, R]
  57. def setCookie(name: String): Header[CookieValueWithMeta]
  58. def setCookies: Header[List[CookieWithMeta]]
  59. def statusCode(statusCode: StatusCode): FixedStatusCode[Unit]
  60. def statusCode: StatusCode[StatusCode]
  61. 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.

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

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

  64. def stringBody(charset: Charset): Body[String, String]
  65. def stringBody(charset: String): Body[String, String]
  66. def stringBody: Body[String, String]
  67. implicit def stringToPath(s: String): FixedPath[Unit]
  68. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  69. def toString(): String
    Definition Classes
    AnyRef → Any
  70. implicit def traversableModifyFunctor[F[_], A](implicit fac: Factory[A, F[A]], ev: (F[A]) => Iterable[A]): ModifyFunctor[F, A]
    Definition Classes
    ModifyMacroSupport
  71. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  72. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  73. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  74. 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.

  75. def webSocketBodyRaw[S](s: Streams[S]): WebSocketBodyOutput[Pipe[WebSocketFrame, WebSocketFrame], WebSocketFrame, WebSocketFrame, Pipe[WebSocketFrame, WebSocketFrame], S]
  76. 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 anyJsonBody[T](implicit arg0: JsonCodec[T]): Body[String, T]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18.0) Use customJsonBody

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  3. def statusDefaultMapping[T](output: EndpointOutput[T]): OneOfMapping[T]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18) Use oneOfDefaultMapping

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

  5. def statusMappingClassMatcher[T](statusCode: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfMapping[T]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18) Use oneOfMappingClassMatcher

  6. def statusMappingExactMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfMapping[T]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18) Use oneOfMappingExactMatcher

  7. def statusMappingFromMatchType[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfMapping[T]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18) Use oneOfMappingFromMatchType

  8. def statusMappingValueMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfMapping[T]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18) Use oneOfMappingValueMatcher

Inherited from TapirMacros

Inherited from ModifyMacroSupport

Inherited from ModifyMacroFunctorSupport

Inherited from TapirStaticContentEndpoints

Inherited from TapirComputedInputs

Inherited from TapirExtensions

Inherited from AnyRef

Inherited from Any

Ungrouped