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

Package Members

  1. package json

Type Members

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

Value Members

  1. def anyFromStringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF], charset: Charset): Body[String, T]
    Definition Classes
    Tapir
  2. def anyFromUtf8StringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF]): Body[String, T]
    Definition Classes
    Tapir
  3. def auth: TapirAuth.type
    Definition Classes
    Tapir
  4. def binaryBody[R, T](implicit arg0: Binary[R], arg1: Codec[R, T, OctetStream]): Body[R, T]
    Definition Classes
    Tapir
  5. def byteArrayBody: Body[Array[Byte], Array[Byte]]
    Definition Classes
    Tapir
  6. def byteBufferBody: Body[ByteBuffer, ByteBuffer]
    Definition Classes
    Tapir
  7. def clientIp: EndpointInput[Option[String]]
    Definition Classes
    TapirComputedInputs
  8. def cookie[T](name: String)(implicit arg0: Codec[Option[String], T, TextPlain]): Cookie[T]
    Definition Classes
    Tapir
  9. def cookies: Header[List[Cookie]]
    Definition Classes
    Tapir
  10. def customJsonBody[T](implicit arg0: JsonCodec[T]): Body[String, T]
    Definition Classes
    Tapir
  11. val emptyOutput: Empty[Unit]
    Definition Classes
    Tapir
  12. def emptyOutputAs[T](value: T): Basic[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 fileGetServerEndpoint[F[_]](path: EndpointInput[Unit])(systemPath: String): ServerEndpoint[Any, F]
    Definition Classes
    TapirStaticContentEndpoints
  17. def fileRangeBody: Body[FileRange, FileRange]
    Definition Classes
    Tapir
  18. def fileServerEndpoints[F[_]](prefix: EndpointInput[Unit])(systemPath: String): List[ServerEndpoint[Any, F]]
    Definition Classes
    TapirStaticContentEndpoints
  19. def filesGetEndpoint(prefix: EndpointInput[Unit]): PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[FileRange], Any]
    Definition Classes
    TapirStaticContentEndpoints
  20. def filesGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String): ServerEndpoint[Any, F]
    Definition Classes
    TapirStaticContentEndpoints
  21. def filesHeadServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String): ServerEndpoint[Any, F]
    Definition Classes
    TapirStaticContentEndpoints
  22. def formBody[T](charset: Charset)(implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
    Definition Classes
    Tapir
  23. def formBody[T](implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
    Definition Classes
    Tapir
  24. def header(name: String, value: String): FixedHeader[Unit]
    Definition Classes
    Tapir
  25. def header(h: Header): FixedHeader[Unit]
    Definition Classes
    Tapir
  26. def header[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Header[T]
    Definition Classes
    Tapir
  27. def headers: Headers[List[Header]]
    Definition Classes
    Tapir
  28. val htmlBodyUtf8: Body[String, String]
    Definition Classes
    Tapir
  29. val infallibleEndpoint: PublicEndpoint[Unit, Nothing, Unit, Any]
    Definition Classes
    Tapir
  30. def inputStreamBody: Body[InputStream, InputStream]
    Definition Classes
    Tapir
  31. def isWebSocket: EndpointInput[Boolean]
    Definition Classes
    TapirComputedInputs
  32. def multipartBody[T](implicit multipartCodec: MultipartCodec[T]): Body[Seq[RawPart], T]
    Definition Classes
    Tapir
  33. val multipartBody: Body[Seq[RawPart], Seq[Part[Array[Byte]]]]
    Definition Classes
    Tapir
  34. def oneOf[T](firstVariant: OneOfVariant[_ <: T], otherVariants: OneOfVariant[_ <: T]*): OneOf[T, T]
    Definition Classes
    Tapir
  35. def oneOfDefaultVariant[T](output: EndpointOutput[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  36. def oneOfVariant[T](code: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T], arg1: ErasureSameAsType[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  37. def oneOfVariant[T](output: EndpointOutput[T])(implicit arg0: ClassTag[T], arg1: ErasureSameAsType[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  38. def oneOfVariantClassMatcher[T](code: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfVariant[T]
    Definition Classes
    Tapir
  39. def oneOfVariantClassMatcher[T](output: EndpointOutput[T], runtimeClass: Class[_]): OneOfVariant[T]
    Definition Classes
    Tapir
  40. def oneOfVariantExactMatcher[T](code: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  41. def oneOfVariantExactMatcher[T](output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  42. def oneOfVariantFromMatchType[T](code: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  43. def oneOfVariantFromMatchType[T](output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfVariant[T]
    Definition Classes
    Tapir
  44. def oneOfVariantValueMatcher[T](code: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfVariant[T]
    Definition Classes
    Tapir
  45. def oneOfVariantValueMatcher[T](output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfVariant[T]
    Definition Classes
    Tapir
  46. implicit def optionModifyFunctor[A]: ModifyFunctor[Option, A]
    Definition Classes
    ModifyMacroFunctorSupport
  47. def path[T](name: String)(implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
    Definition Classes
    Tapir
  48. def path[T](implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
    Definition Classes
    Tapir
  49. def pathBody: Body[FileRange, Path]
    Definition Classes
    TapirExtensions
  50. def paths: PathsCapture[List[String]]
    Definition Classes
    Tapir
  51. def plainBody[T](charset: Charset)(implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
    Definition Classes
    Tapir
  52. def plainBody[T](implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
    Definition Classes
    Tapir
  53. def query[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Query[T]
    Definition Classes
    Tapir
  54. def queryParams: QueryParams[QueryParams]
    Definition Classes
    Tapir
  55. def rawBinaryBody[R](implicit arg0: Binary[R], codec: Codec[R, R, OctetStream]): Body[R, R]
    Definition Classes
    Tapir
  56. def resourceGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePath: String, useGzippedIfAvailable: Boolean): ServerEndpoint[Any, F]
    Definition Classes
    TapirStaticContentEndpoints
  57. def resourcesGetEndpoint(prefix: EndpointInput[Unit]): PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[InputStream], Any]
    Definition Classes
    TapirStaticContentEndpoints
  58. def resourcesGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePrefix: String, useGzippedIfAvailable: Boolean): ServerEndpoint[Any, F]
    Definition Classes
    TapirStaticContentEndpoints
  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]): 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. implicit def stringToPath(s: String): FixedPath[Unit]
    Definition Classes
    Tapir
  71. implicit def traversableModifyFunctor[F[_], A](implicit fac: Factory[A, F[A]], ev: (F[A]) => Iterable[A]): ModifyFunctor[F, A]
    Definition Classes
    ModifyMacroSupport
  72. def webSocketBody[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat]: WebSocketBodyBuilder[REQ, REQ_CF, RESP, RESP_CF]
    Definition Classes
    Tapir
  73. def webSocketBodyRaw[S](s: Streams[S]): WebSocketBodyOutput[Pipe[WebSocketFrame, WebSocketFrame], WebSocketFrame, WebSocketFrame, Pipe[WebSocketFrame, WebSocketFrame], S]
    Definition Classes
    Tapir
  74. def xmlBody[T](implicit arg0: XmlCodec[T]): Body[String, T]
    Definition Classes
    Tapir

Deprecated Value Members

  1. def anyJsonBody[T](implicit arg0: JsonCodec[T]): Body[String, T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18.0) Use customJsonBody

  2. def oneOfDefaultMapping[T](output: EndpointOutput[T]): OneOfVariant[T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Use oneOfDefaultVariant

  3. def oneOfMapping[T](code: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T], arg1: ErasureSameAsType[T]): OneOfVariant[T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Use oneOfVariant

  4. def oneOfMappingClassMatcher[T](code: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfVariant[T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Use oneOfVariantClassMatcher

  5. def oneOfMappingExactMatcher[T](code: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfVariant[T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Use oneOfVariantExactMatcher

  6. def oneOfMappingFromMatchType[T](code: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfVariant[T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Use oneOfVariantFromMatchType

  7. def oneOfMappingValueMatcher[T](code: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfVariant[T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Use oneOfVariantValueMatcher

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