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. trait Codec[T, M <: MediaType, R] extends GeneralCodec[T, M, R]

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

    A pair of functions, one to encode a non-optional 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.

  2. case class CodecMeta[M <: MediaType] extends Product with Serializable
  3. sealed trait DecodeResult[+T] extends AnyRef
  4. case class Endpoint[I, E, O, +S](method: Method, 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.

  5. sealed trait EndpointIO[I] extends EndpointInput[I]
  6. case class EndpointInfo(name: Option[String], summary: Option[String], description: Option[String], tags: Vector[String]) extends Product with Serializable
  7. sealed trait EndpointInput[I] extends AnyRef
  8. trait GeneralCodec[T, M <: MediaType, R] extends AnyRef

    A codec which can encode/decode both optional and non-optional values of type T to raw values of type R.

    A codec which can encode/decode both optional and non-optional values of type T to raw values of type R. Base trait for all codecs.

  9. trait MediaType extends AnyRef
  10. final case class Method(m: String) extends AnyVal with Product with Serializable
  11. class MultiQueryParams extends AnyRef
  12. sealed trait RawValueType[R] extends AnyRef
  13. sealed trait Schema extends AnyRef
  14. trait SchemaFor[T] extends AnyRef
  15. type StatusCode = Int
  16. trait StatusCodes extends AnyRef
  17. sealed trait StreamingEndpointIO[I, +S] extends AnyRef
  18. case class StringValueType(charset: Charset) extends RawValueType[String] with Product with Serializable
  19. trait Tapir extends AnyRef
  20. case class InvalidOutput(reason: DecodeResult[Nothing], cause: Option[Throwable]) extends Exception with Product with Serializable
    Definition Classes
    Tapir

Value Members

  1. def binaryBody[T](implicit codec: GeneralCodec[T, OctetStream, _]): Body[T, OctetStream, _]
    Definition Classes
    Tapir
  2. def body[T, M <: MediaType](implicit tm: GeneralCodec[T, M, _]): Body[T, M, _]
    Definition Classes
    Tapir
  3. val endpoint: Endpoint[Unit, Unit, Unit, Nothing]
    Definition Classes
    Tapir
  4. def formBody[T](implicit codec: GeneralCodec[T, XWwwFormUrlencoded, _]): Body[T, XWwwFormUrlencoded, _]
    Definition Classes
    Tapir
  5. def header[T](name: String)(implicit arg0: GeneralPlainCodec[T]): Header[T]
    Definition Classes
    Tapir
  6. def headers: Headers
    Definition Classes
    Tapir
  7. def jsonBody[T](implicit codec: GeneralCodec[T, Json, _]): Body[T, Json, _]
    Definition Classes
    Tapir
  8. def path[T](name: String)(implicit arg0: PlainCodec[T]): PathCapture[T]
    Definition Classes
    Tapir
  9. def path[T](implicit arg0: PlainCodec[T]): PathCapture[T]
    Definition Classes
    Tapir
  10. def paths: PathsCapture
    Definition Classes
    Tapir
  11. def plainBody[T](implicit codec: GeneralCodec[T, TextPlain, _]): Body[T, TextPlain, _]
    Definition Classes
    Tapir
  12. def query[T](name: String)(implicit arg0: GeneralPlainCodec[T]): Query[T]
    Definition Classes
    Tapir
  13. def queryParams: QueryParams
    Definition Classes
    Tapir
  14. def schemaFor[T](implicit arg0: SchemaFor[T]): Schema
    Definition Classes
    Tapir
  15. def streamBody[S](schema: Schema, mediaType: MediaType): Body[S, mediaType.type]
    Definition Classes
    Tapir
  16. def stringBody(charset: Charset): Body[String, TextPlain, String]
    Definition Classes
    Tapir
  17. def stringBody(charset: String): Body[String, TextPlain, String]
    Definition Classes
    Tapir
  18. def stringBody: Body[String, TextPlain, String]
    Definition Classes
    Tapir
  19. implicit def stringToPath(s: String): EndpointInput[Unit]
    Definition Classes
    Tapir
  20. object ByteArrayValueType extends RawValueType[Array[Byte]] with Product with Serializable
  21. object ByteBufferValueType extends RawValueType[ByteBuffer] with Product with Serializable
  22. object CodecMeta extends Serializable
  23. object DecodeResult
  24. object Defaults
  25. object EndpointIO
  26. object EndpointInput
  27. object FileValueType extends RawValueType[File] with Product with Serializable
  28. object GeneralCodec extends FormCodecDerivation
  29. object InputStreamValueType extends RawValueType[InputStream] with Product with Serializable
  30. object MediaType
  31. object Method extends Serializable
  32. object MultiQueryParams
  33. object Schema
  34. object SchemaFor extends SchemaForMagnoliaDerivation
  35. object StatusCodes extends StatusCodes
  36. object StreamingEndpointIO

Inherited from Tapir

Inherited from AnyRef

Inherited from Any

Ungrouped