Packages

p

sttp

tapir

package tapir

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

Type Members

  1. type AnyEndpoint = Endpoint[_, _, _, _, _]
  2. type AnyListCodec = Codec[_ <: List[_], _, _ <: CodecFormat]
  3. type AnyPart = Part[_]
  4. class BinaryBodyPartiallyApplied[R] extends AnyRef
    Definition Classes
    Tapir
  5. implicit class ModifyEach[F[_], T] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  6. implicit class ModifyEachMap[F[_, _], K, T] extends AnyRef
    Definition Classes
    ModifyMacroSupport
  7. trait ModifyFunctor[F[_], A] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  8. trait ModifyMapAtFunctor[F[_, _], K, T] extends AnyRef
    Definition Classes
    ModifyMacroSupport
  9. type PublicEndpoint[INPUT, ERROR_OUTPUT, OUTPUT, -R] = Endpoint[Unit, INPUT, ERROR_OUTPUT, OUTPUT, R]
  10. type RawPart = Part[_]
  11. type TapirFile = File
    Definition Classes
    TapirExtensions
  12. final class WebSocketBodyBuilder[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat] extends AnyRef
    Definition Classes
    Tapir

Value Members

  1. def auth: TapirAuth.type
    Definition Classes
    Tapir
  2. def binaryBody[R](rbt: Binary[R]): BinaryBodyPartiallyApplied[R]
    Definition Classes
    Tapir
  3. def byteArrayBody: Body[Array[Byte], Array[Byte]]
    Definition Classes
    Tapir
  4. def byteBufferBody: Body[ByteBuffer, ByteBuffer]
    Definition Classes
    Tapir
  5. def clientIp: EndpointInput[Option[String]]
    Definition Classes
    TapirComputedInputs
  6. def cookie[T](name: String)(implicit arg0: Codec[Option[String], T, TextPlain]): Cookie[T]
    Definition Classes
    Tapir
  7. def cookies: Header[List[Cookie]]
    Definition Classes
    Tapir
  8. def customCodecJsonBody[T](implicit arg0: JsonCodec[T]): Body[String, T]
    Definition Classes
    Tapir
  9. val emptyAuth: Auth[Unit, ApiKey]
    Definition Classes
    Tapir
  10. val emptyInput: EndpointInput[Unit]
    Definition Classes
    Tapir
  11. val emptyOutput: Atom[Unit]
    Definition Classes
    Tapir
  12. def emptyOutputAs[T](value: T): Atom[T]
    Definition Classes
    Tapir
  13. val endpoint: PublicEndpoint[Unit, Unit, Unit, Any]
    Definition Classes
    Tapir
  14. def extractFromRequest[T](f: (ServerRequest) ⇒ T): ExtractFromRequest[T]
    Definition Classes
    Tapir
  15. def fileBody: Body[FileRange, TapirFile]
    Definition Classes
    Tapir
  16. def fileRangeBody: Body[FileRange, FileRange]
    Definition Classes
    Tapir
  17. def formBody[T](charset: Charset)(implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
    Definition Classes
    Tapir
  18. def formBody[T](implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
    Definition Classes
    Tapir
  19. def header(name: String, value: String): FixedHeader[Unit]
    Definition Classes
    Tapir
  20. def header(h: Header): FixedHeader[Unit]
    Definition Classes
    Tapir
  21. def header[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Header[T]
    Definition Classes
    Tapir
  22. def headers: Headers[List[Header]]
    Definition Classes
    Tapir
  23. val htmlBodyUtf8: Body[String, String]
    Definition Classes
    Tapir
  24. val infallibleEndpoint: PublicEndpoint[Unit, Nothing, Unit, Any]
    Definition Classes
    Tapir
  25. def inputStreamBody: Body[InputStream, InputStream]
    Definition Classes
    Tapir
  26. def inputStreamRangeBody: Body[InputStreamRange, InputStreamRange]
    Definition Classes
    Tapir
  27. def isWebSocket: EndpointInput[Boolean]
    Definition Classes
    TapirComputedInputs
  28. 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
  29. def multipartBody[T](implicit multipartCodec: MultipartCodec[T]): Body[Seq[RawPart], T]
    Definition Classes
    Tapir
  30. val multipartBody: Body[Seq[RawPart], Seq[Part[Array[Byte]]]]
    Definition Classes
    Tapir
  31. val noTrailingSlash: EndpointInput[Unit]
    Definition Classes
    TapirComputedInputs
  32. def oneOf[T](firstVariant: OneOfVariant[_ <: T], otherVariants: OneOfVariant[_ <: T]*): OneOf[T, T]
    Definition Classes
    Tapir
  33. def oneOfBody[T](first: (ContentTypeRange, StreamBodyWrapper[_, T]), second: (ContentTypeRange, StreamBodyWrapper[_, T]), others: (ContentTypeRange, StreamBodyWrapper[_, T])*): OneOfBody[T, T]
    Definition Classes
    Tapir
  34. def oneOfBody[T](first: (ContentTypeRange, Body[_, T]), others: (ContentTypeRange, Body[_, T])*): OneOfBody[T, T]
    Definition Classes
    Tapir
  35. def oneOfBody[T](first: StreamBodyWrapper[_, T], others: StreamBodyWrapper[_, T]*): OneOfBody[T, T]
    Definition Classes
    Tapir
  36. def oneOfBody[T](first: Body[_, T], others: Body[_, T]*): OneOfBody[T, T]
    Definition Classes
    Tapir
  37. def oneOfDefaultVariant[T](output: EndpointOutput[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  38. def oneOfVariant[T](code: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T], arg1: ErasureSameAsType[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  39. def oneOfVariant[T](output: EndpointOutput[T])(implicit arg0: ClassTag[T], arg1: ErasureSameAsType[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  40. def oneOfVariantClassMatcher[T](code: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfVariant[T]
    Definition Classes
    Tapir
  41. def oneOfVariantClassMatcher[T](output: EndpointOutput[T], runtimeClass: Class[_]): OneOfVariant[T]
    Definition Classes
    Tapir
  42. def oneOfVariantExactMatcher[T](code: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  43. def oneOfVariantExactMatcher[T](output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  44. def oneOfVariantFromMatchType[T](code: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  45. def oneOfVariantFromMatchType[T](output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  46. def oneOfVariantValueMatcher[T](code: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfVariant[T]
    Definition Classes
    Tapir
  47. def oneOfVariantValueMatcher[T](output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfVariant[T]
    Definition Classes
    Tapir
  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]
    Definition Classes
    Tapir
  50. def path[T](implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
    Definition Classes
    Tapir
  51. def pathBody: Body[FileRange, Path]
    Definition Classes
    TapirExtensions
  52. def paths: PathsCapture[List[String]]
    Definition Classes
    Tapir
  53. def plainBody[T](charset: Charset)(implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
    Definition Classes
    Tapir
  54. def plainBody[T](implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
    Definition Classes
    Tapir
  55. def query[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Query[T]
    Definition Classes
    Tapir
  56. def queryAnyFormat[T, CF <: CodecFormat](name: String, codec: Codec[List[String], T, CF]): Query[T]
    Definition Classes
    Tapir
  57. def queryParams: QueryParams[QueryParams]
    Definition Classes
    Tapir
  58. def rawBinaryBody[R](rbt: Binary[R])(implicit codec: Codec[R, R, OctetStream]): Body[R, R]
    Definition Classes
    Tapir
  59. def setCookie(name: String): Header[CookieValueWithMeta]
    Definition Classes
    Tapir
  60. def setCookieOpt(name: String): Header[Option[CookieValueWithMeta]]
    Definition Classes
    Tapir
  61. def setCookies: Header[List[CookieWithMeta]]
    Definition Classes
    Tapir
  62. def statusCode(statusCode: StatusCode): FixedStatusCode[Unit]
    Definition Classes
    Tapir
  63. def statusCode: StatusCode[StatusCode]
    Definition Classes
    Tapir
  64. def streamBinaryBody[S](s: Streams[S])(format: CodecFormat): StreamBodyIO[BinaryStream, BinaryStream, S]
    Definition Classes
    Tapir
  65. def streamBody[S, T](s: Streams[S])(schema: Schema[T], format: CodecFormat, charset: Option[Charset]): StreamBodyIO[BinaryStream, BinaryStream, S]
    Definition Classes
    Tapir
  66. def streamTextBody[S](s: Streams[S])(format: CodecFormat, charset: Option[Charset]): StreamBodyIO[BinaryStream, BinaryStream, S]
    Definition Classes
    Tapir
  67. def stringBody(charset: Charset): Body[String, String]
    Definition Classes
    Tapir
  68. def stringBody(charset: String): Body[String, String]
    Definition Classes
    Tapir
  69. def stringBody: Body[String, String]
    Definition Classes
    Tapir
  70. def stringBodyAnyFormat[T, CF <: CodecFormat](codec: Codec[String, T, CF], charset: Charset): Body[String, T]
    Definition Classes
    Tapir
  71. def stringBodyUtf8AnyFormat[T, CF <: CodecFormat](codec: Codec[String, T, CF]): Body[String, T]
    Definition Classes
    Tapir
  72. def stringJsonBody(charset: Charset): Body[String, String]
    Definition Classes
    Tapir
  73. def stringJsonBody: Body[String, String]
    Definition Classes
    Tapir
  74. implicit def stringToPath(s: String): FixedPath[Unit]
    Definition Classes
    Tapir
  75. 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
  76. def webSocketBody[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat]: WebSocketBodyBuilder[REQ, REQ_CF, RESP, RESP_CF]
    Definition Classes
    Tapir
  77. def webSocketBodyRaw[S](s: Streams[S]): WebSocketBodyOutput[Pipe[WebSocketFrame, WebSocketFrame], WebSocketFrame, WebSocketFrame, Pipe[WebSocketFrame, WebSocketFrame], S]
    Definition Classes
    Tapir
  78. def xmlBody[T](implicit arg0: XmlCodec[T]): Body[String, T]
    Definition Classes
    Tapir

Deprecated Value Members

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

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

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

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

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

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

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

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

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

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

Inherited from Tapir

Inherited from ModifyMacroSupport

Inherited from ModifyMacroFunctorSupport

Inherited from TapirStaticContentEndpoints

Inherited from TapirComputedInputs

Inherited from TapirExtensions

Inherited from AnyRef

Inherited from Any

Ungrouped