Packages

p

sttp

tapir

package tapir

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

Package Members

  1. package json

Type Members

  1. type AnyListCodec = Codec[_ <: List[_], _, _ <: CodecFormat]
  2. type AnyPart = Part[_]
  3. implicit class ModifyEach[F[_], T] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  4. implicit class ModifyEachMap[F[_, _], K, T] extends AnyRef
    Definition Classes
    ModifyMacroSupport
  5. trait ModifyFunctor[F[_], A] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  6. type RawPart = Part[_]
  7. type TapirFile = File
    Definition Classes
    TapirExtensions
  8. 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: Endpoint[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 fileServerEndpoint[F[_]](path: EndpointInput[Unit])(systemPath: String): ServerEndpoint[StaticInput, StaticErrorOutput, StaticOutput[FileRange], Any, F]
    Definition Classes
    TapirStaticContentEndpoints
  18. def filesEndpoint(prefix: EndpointInput[Unit]): Endpoint[StaticInput, StaticErrorOutput, StaticOutput[FileRange], Any]
    Definition Classes
    TapirStaticContentEndpoints
  19. def filesServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String): ServerEndpoint[StaticInput, StaticErrorOutput, StaticOutput[FileRange], Any, F]
    Definition Classes
    TapirStaticContentEndpoints
  20. def formBody[T](charset: Charset)(implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
    Definition Classes
    Tapir
  21. def formBody[T](implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
    Definition Classes
    Tapir
  22. def header(name: String, value: String): FixedHeader[Unit]
    Definition Classes
    Tapir
  23. def header(h: Header): FixedHeader[Unit]
    Definition Classes
    Tapir
  24. def header[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Header[T]
    Definition Classes
    Tapir
  25. def headers: Headers[List[Header]]
    Definition Classes
    Tapir
  26. val htmlBodyUtf8: Body[String, String]
    Definition Classes
    Tapir
  27. val infallibleEndpoint: Endpoint[Unit, Nothing, Unit, Any]
    Definition Classes
    Tapir
  28. def inputStreamBody: Body[InputStream, InputStream]
    Definition Classes
    Tapir
  29. def isWebSocket: EndpointInput[Boolean]
    Definition Classes
    TapirComputedInputs
  30. def multipartBody[T](implicit multipartCodec: MultipartCodec[T]): Body[Seq[RawPart], T]
    Definition Classes
    Tapir
  31. val multipartBody: Body[Seq[RawPart], Seq[Part[Array[Byte]]]]
    Definition Classes
    Tapir
  32. def oneOf[T](firstCase: OneOfMapping[_ <: T], otherCases: OneOfMapping[_ <: T]*): OneOf[T, T]
    Definition Classes
    Tapir
  33. def oneOfDefaultMapping[T](output: EndpointOutput[T]): OneOfMapping[T]
    Definition Classes
    Tapir
  34. macro def oneOfMapping[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T]): OneOfMapping[T]
    Definition Classes
    TapirMacros
  35. def oneOfMappingClassMatcher[T](statusCode: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): OneOfMapping[T]
    Definition Classes
    Tapir
  36. def oneOfMappingExactMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): OneOfMapping[T]
    Definition Classes
    Tapir
  37. def oneOfMappingFromMatchType[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): OneOfMapping[T]
    Definition Classes
    Tapir
  38. def oneOfMappingValueMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): OneOfMapping[T]
    Definition Classes
    Tapir
  39. implicit def optionModifyFunctor[A]: ModifyFunctor[Option, A]
    Definition Classes
    ModifyMacroFunctorSupport
  40. def path[T](name: String)(implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
    Definition Classes
    Tapir
  41. def path[T](implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
    Definition Classes
    Tapir
  42. def pathBody: Body[FileRange, Path]
    Definition Classes
    TapirExtensions
  43. def paths: PathsCapture[List[String]]
    Definition Classes
    Tapir
  44. def plainBody[T](charset: Charset)(implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
    Definition Classes
    Tapir
  45. def plainBody[T](implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
    Definition Classes
    Tapir
  46. def query[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Query[T]
    Definition Classes
    Tapir
  47. def queryParams: QueryParams[QueryParams]
    Definition Classes
    Tapir
  48. def rawBinaryBody[R](implicit arg0: Binary[R], codec: Codec[R, R, OctetStream]): Body[R, R]
    Definition Classes
    Tapir
  49. def resourceServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePath: String): ServerEndpoint[StaticInput, StaticErrorOutput, StaticOutput[InputStream], Any, F]
    Definition Classes
    TapirStaticContentEndpoints
  50. def resourcesEndpoint(prefix: EndpointInput[Unit]): Endpoint[StaticInput, StaticErrorOutput, StaticOutput[InputStream], Any]
    Definition Classes
    TapirStaticContentEndpoints
  51. def resourcesServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePrefix: String): ServerEndpoint[StaticInput, StaticErrorOutput, StaticOutput[InputStream], Any, F]
    Definition Classes
    TapirStaticContentEndpoints
  52. def setCookie(name: String): Header[CookieValueWithMeta]
    Definition Classes
    Tapir
  53. def setCookieOpt(name: String): Header[Option[CookieValueWithMeta]]
    Definition Classes
    Tapir
  54. def setCookies: Header[List[CookieWithMeta]]
    Definition Classes
    Tapir
  55. def statusCode(statusCode: StatusCode): FixedStatusCode[Unit]
    Definition Classes
    Tapir
  56. def statusCode: StatusCode[StatusCode]
    Definition Classes
    Tapir
  57. def streamBinaryBody[S](s: Streams[S]): StreamBodyIO[BinaryStream, BinaryStream, S]
    Definition Classes
    Tapir
  58. def streamBody[S, T](s: Streams[S])(schema: Schema[T], format: CodecFormat, charset: Option[Charset]): StreamBodyIO[BinaryStream, BinaryStream, S]
    Definition Classes
    Tapir
  59. def streamTextBody[S](s: Streams[S])(format: CodecFormat, charset: Option[Charset]): StreamBodyIO[BinaryStream, BinaryStream, S]
    Definition Classes
    Tapir
  60. def stringBody(charset: Charset): Body[String, String]
    Definition Classes
    Tapir
  61. def stringBody(charset: String): Body[String, String]
    Definition Classes
    Tapir
  62. def stringBody: Body[String, String]
    Definition Classes
    Tapir
  63. implicit def stringToPath(s: String): FixedPath[Unit]
    Definition Classes
    Tapir
  64. implicit def traversableModifyFunctor[F[_], A](implicit fac: Factory[A, F[A]], ev: (F[A]) => Iterable[A]): ModifyFunctor[F, A]
    Definition Classes
    ModifyMacroSupport
  65. def webSocketBody[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat]: WebSocketBodyBuilder[REQ, REQ_CF, RESP, RESP_CF]
    Definition Classes
    Tapir
  66. def webSocketBodyRaw[S](s: Streams[S]): WebSocketBodyOutput[Pipe[WebSocketFrame, WebSocketFrame], WebSocketFrame, WebSocketFrame, Pipe[WebSocketFrame, WebSocketFrame], S]
    Definition Classes
    Tapir
  67. 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 statusDefaultMapping[T](output: EndpointOutput[T]): OneOfMapping[T]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18) Use oneOfDefaultMapping

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

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

    (Since version 0.18) Use oneOfMappingClassMatcher

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

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

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

Inherited from Tapir

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