p

tapir

package tapir

Linear Supertypes
Tapir, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. tapir
  2. Tapir
  3. AnyRef
  4. 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 AnyRef

    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.

  6. trait CodecForMany[T, M <: MediaType, R] extends AnyRef

    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.

  7. trait CodecForOptional[T, M <: MediaType, R] extends AnyRef

    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.

  8. case class CodecMeta[M <: MediaType, R] extends Product with Serializable
  9. sealed trait DecodeFailure extends DecodeResult[Nothing]
  10. sealed trait DecodeResult[+T] extends AnyRef
  11. case class Endpoint[I, E, O, +S](input: EndpointInput[I], errorOutput: EndpointIO[E], output: EndpointIO[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.

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

    Describe conditions for status code mapping using Tapir.statusFrom.

  26. case class WhenClass[T](ct: ClassTag[T], s: Schema) extends When[Any] with Product with Serializable
  27. 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 cookie[T](name: String)(implicit arg0: PlainCodecForOptional[T]): Cookie[T]
    Definition Classes
    Tapir
  5. def cookies: Header[List[Cookie]]
    Definition Classes
    Tapir
  6. val endpoint: Endpoint[Unit, Unit, Unit, Nothing]
    Definition Classes
    Tapir
  7. def formBody[T](implicit codec: CodecForOptional[T, XWwwFormUrlencoded, _]): Body[T, XWwwFormUrlencoded, _]
    Definition Classes
    Tapir
  8. def header[T](name: String)(implicit arg0: PlainCodecForMany[T]): Header[T]
    Definition Classes
    Tapir
  9. def headers: Headers
    Definition Classes
    Tapir
  10. def jsonBody[T](implicit codec: CodecForOptional[T, Json, _]): Body[T, Json, _]
    Definition Classes
    Tapir
  11. def multipartBody[T](implicit codec: CodecForOptional[T, MultipartFormData, _]): Body[T, MultipartFormData, _]
    Definition Classes
    Tapir
  12. def path[T](name: String)(implicit arg0: PlainCodec[T]): PathCapture[T]
    Definition Classes
    Tapir
  13. def path[T](implicit arg0: PlainCodec[T]): PathCapture[T]
    Definition Classes
    Tapir
  14. def paths: PathsCapture
    Definition Classes
    Tapir
  15. def plainBody[T](implicit codec: CodecForOptional[T, TextPlain, _]): Body[T, TextPlain, _]
    Definition Classes
    Tapir
  16. def query[T](name: String)(implicit arg0: PlainCodecForMany[T]): Query[T]
    Definition Classes
    Tapir
  17. def queryParams: QueryParams
    Definition Classes
    Tapir
  18. def schemaFor[T](implicit arg0: SchemaFor[T]): Schema
    Definition Classes
    Tapir
  19. def setCookie(name: String): Header[SetCookieValue]
    Definition Classes
    Tapir
  20. def setCookies: Header[List[SetCookie]]
    Definition Classes
    Tapir
  21. def statusFrom[I](io: EndpointIO[I], default: StatusCode, when: (When[I], StatusCode)*): StatusFrom[I]
    Definition Classes
    Tapir
  22. def streamBody[S](schema: Schema, mediaType: MediaType): Body[S, mediaType.type]
    Definition Classes
    Tapir
  23. def stringBody(charset: Charset): Body[String, TextPlain, String]
    Definition Classes
    Tapir
  24. def stringBody(charset: String): Body[String, TextPlain, String]
    Definition Classes
    Tapir
  25. def stringBody: Body[String, TextPlain, String]
    Definition Classes
    Tapir
  26. implicit def stringToPath(s: String): EndpointInput[Unit]
    Definition Classes
    Tapir
  27. def whenClass[U](implicit arg0: ClassTag[U], arg1: SchemaFor[U]): When[Any]
    Definition Classes
    Tapir
  28. def whenValue[U](p: (U) ⇒ Boolean): When[U]
    Definition Classes
    Tapir
  29. object ByteArrayValueType extends RawValueType[Array[Byte]] with Product with Serializable
  30. object ByteBufferValueType extends RawValueType[ByteBuffer] with Product with Serializable
  31. object Codec extends FormCodecDerivation with MultipartCodecDerivation
  32. object CodecForMany
  33. object CodecForOptional
  34. object CodecMeta extends Serializable
  35. object DecodeResult
  36. object Defaults
  37. object EndpointIO
  38. object EndpointInput
  39. object FileValueType extends RawValueType[File] with Product with Serializable
  40. object InputStreamValueType extends RawValueType[InputStream] with Product with Serializable
  41. object MediaType
  42. object Schema
  43. object SchemaFor extends SchemaForMagnoliaDerivation
  44. object StreamingEndpointIO
  45. object TapirAuth

Inherited from Tapir

Inherited from AnyRef

Inherited from Any

Ungrouped