p

tapir

package tapir

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. tapir
  2. Tapir
  3. TapirDerivedInputs
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type AnyCodec = Codec[_, _ <: MediaType, _]
  2. type AnyCodecForMany = CodecForMany[_, _ <: MediaType, _]
  3. type AnyCodecMeta = CodecMeta[_ <: MediaType, _]
  4. type AnyPart = Part[_]
  5. trait Codec[T, M <: MediaType, R] extends Decode[R, T]

    A pair of functions, one to encode a value of type T to a raw value of type R, and another one to decode.

    A pair of functions, one to encode a value of type T to a raw value of type R, and another one to decode.

    Also contains meta-data on the schema of the value, the media type and the raw value type.

    T

    Type of the values which can be encoded / to which raw values can be decoded.

    M

    The media type of encoded values.

    R

    Type of the raw value to which values are encoded.

    Annotations
    @implicitNotFound( ... )
  6. trait CodecForMany[T, M <: MediaType, R] extends Decode[Seq[R], T]

    A codec which can encode to multiple (0..n) raw values / decode from multiple raw values.

    A codec which can encode to multiple (0..n) raw values / decode from multiple raw values. An multiple raw value specifies that the raw values should be included in the output multiple times. Depending on the codec, decoding from a multiple value might yield DecodeResult.Missing or DecodeResult.Multiple.

    Should be used for inputs/outputs which allow multiple values.

    Annotations
    @implicitNotFound( ... )
  7. trait CodecForOptional[T, M <: MediaType, R] extends Decode[Option[R], T]

    A codec which can encode to optional raw values / decode from optional raw values.

    A codec which can encode to optional raw values / decode from optional raw values. An optional raw value specifies if the raw value should be included in the output, or not. Depending on the codec, decoding from an optional value might yield DecodeResult.Missing.

    Should be used for inputs/outputs which allow optional values.

    Annotations
    @implicitNotFound( ... )
  8. case class CodecMeta[M <: MediaType, R] extends Product with Serializable
  9. trait Decode[F, T] extends AnyRef
  10. sealed trait DecodeFailure extends DecodeResult[Nothing]
  11. sealed trait DecodeResult[+T] extends AnyRef
  12. case class Endpoint[I, E, O, +S](input: EndpointInput[I], errorOutput: EndpointOutput[E], output: EndpointOutput[O], info: EndpointInfo) extends Product with Serializable

    I

    Input parameter types.

    E

    Error output parameter types.

    O

    Output parameter types.

    S

    The type of streams that are used by this endpoint's inputs/outputs. Nothing, if no streams are used.

  13. sealed trait EndpointIO[I] extends EndpointInput[I] with EndpointOutput[I]
  14. case class EndpointInfo(name: Option[String], summary: Option[String], description: Option[String], tags: Vector[String]) extends Product with Serializable
  15. sealed trait EndpointInput[I] extends AnyRef
  16. sealed trait EndpointOutput[I] extends AnyRef
  17. trait MediaType extends AnyRef
  18. case class MultipartValueType(partCodecs: Map[String, AnyCodecForMany], defaultCodec: Option[AnyCodecForMany]) extends RawValueType[Seq[RawPart]] with Product with Serializable
  19. type RawPart = Part[_]
  20. sealed trait RawValueType[R] extends AnyRef
  21. sealed trait Schema extends AnyRef
  22. trait SchemaFor[T] extends AnyRef
  23. type StatusCode = Int
  24. sealed trait StreamingEndpointIO[I, +S] extends AnyRef
  25. case class StringValueType(charset: Charset) extends RawValueType[String] with Product with Serializable
  26. trait Tapir extends TapirDerivedInputs
  27. trait TapirDerivedInputs extends AnyRef
  28. trait When[-I] extends AnyRef

    Describe conditions for status code mapping using Tapir.statusFrom.

  29. case class WhenClass[T](ct: ClassTag[T], s: Schema) extends When[Any] with Product with Serializable
  30. case class WhenValue[T](p: (T) ⇒ Boolean) extends When[T] with Product with Serializable

Value Members

  1. def auth: TapirAuth.type
    Definition Classes
    Tapir
  2. def binaryBody[T](implicit codec: CodecForOptional[T, OctetStream, _]): Body[T, OctetStream, _]
    Definition Classes
    Tapir
  3. def body[T, M <: MediaType](implicit tm: CodecForOptional[T, M, _]): Body[T, M, _]
    Definition Classes
    Tapir
  4. def clientIp: EndpointInput[Option[String]]
    Definition Classes
    TapirDerivedInputs
  5. def cookie[T](name: String)(implicit arg0: PlainCodecForOptional[T]): Cookie[T]
    Definition Classes
    Tapir
  6. def cookies: Header[List[Cookie]]
    Definition Classes
    Tapir
  7. val endpoint: Endpoint[Unit, Unit, Unit, Nothing]
    Definition Classes
    Tapir
  8. 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.

    Definition Classes
    Tapir
  9. def formBody[T](implicit codec: CodecForOptional[T, XWwwFormUrlencoded, _]): Body[T, XWwwFormUrlencoded, _]
    Definition Classes
    Tapir
  10. def header[T](name: String)(implicit arg0: PlainCodecForMany[T]): Header[T]
    Definition Classes
    Tapir
  11. def headers: Headers
    Definition Classes
    Tapir
  12. def jsonBody[T](implicit codec: CodecForOptional[T, Json, _]): Body[T, Json, _]
    Definition Classes
    Tapir
  13. def multipartBody[T](implicit codec: CodecForOptional[T, MultipartFormData, _]): Body[T, MultipartFormData, _]
    Definition Classes
    Tapir
  14. def path[T](name: String)(implicit arg0: PlainCodec[T]): PathCapture[T]
    Definition Classes
    Tapir
  15. def path[T](implicit arg0: PlainCodec[T]): PathCapture[T]
    Definition Classes
    Tapir
  16. def paths: PathsCapture
    Definition Classes
    Tapir
  17. def plainBody[T](implicit codec: CodecForOptional[T, TextPlain, _]): Body[T, TextPlain, _]
    Definition Classes
    Tapir
  18. def query[T](name: String)(implicit arg0: PlainCodecForMany[T]): Query[T]
    Definition Classes
    Tapir
  19. def queryParams: QueryParams
    Definition Classes
    Tapir
  20. def schemaFor[T](implicit arg0: SchemaFor[T]): Schema
    Definition Classes
    Tapir
  21. def setCookie(name: String): Header[SetCookieValue]
    Definition Classes
    Tapir
  22. def setCookies: Header[List[SetCookie]]
    Definition Classes
    Tapir
  23. def statusCode: tapir.EndpointOutput.StatusCode
    Definition Classes
    Tapir
  24. def streamBody[S](schema: Schema, mediaType: MediaType): Body[S, mediaType.type]
    Definition Classes
    Tapir
  25. def stringBody(charset: Charset): Body[String, TextPlain, String]
    Definition Classes
    Tapir
  26. def stringBody(charset: String): Body[String, TextPlain, String]
    Definition Classes
    Tapir
  27. def stringBody: Body[String, TextPlain, String]
    Definition Classes
    Tapir
  28. implicit def stringToPath(s: String): EndpointInput[Unit]
    Definition Classes
    Tapir
  29. def whenClass[U](implicit arg0: ClassTag[U], arg1: SchemaFor[U]): When[Any]
    Definition Classes
    Tapir
  30. def whenValue[U](p: (U) ⇒ Boolean): When[U]
    Definition Classes
    Tapir
  31. object ByteArrayValueType extends RawValueType[Array[Byte]] with Product with Serializable
  32. object ByteBufferValueType extends RawValueType[ByteBuffer] with Product with Serializable
  33. object Codec extends FormCodecDerivation with MultipartCodecDerivation
  34. object CodecForMany
  35. object CodecForOptional
  36. object CodecMeta extends Serializable
  37. object DecodeResult
  38. object Defaults
  39. object EndpointIO
  40. object EndpointInput
  41. object EndpointOutput
  42. object FileValueType extends RawValueType[File] with Product with Serializable
  43. object InputStreamValueType extends RawValueType[InputStream] with Product with Serializable
  44. object MediaType
  45. object Schema
  46. object SchemaFor extends SchemaForMagnoliaDerivation
  47. object StreamingEndpointIO
  48. object TapirAuth

Deprecated Value Members

  1. def statusFrom[I](io: EndpointIO[I], default: StatusCode, when: (When[I], StatusCode)*): StatusFrom[I]
    Definition Classes
    Tapir
    Annotations
    @deprecated
    Deprecated

Inherited from Tapir

Inherited from TapirDerivedInputs

Inherited from AnyRef

Inherited from Any

Ungrouped