trait Tapir extends TapirDerivedInputs
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- Tapir
- TapirDerivedInputs
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def auth: TapirAuth.type
- def binaryBody[T](implicit codec: CodecForOptional[T, OctetStream, _]): Body[T, OctetStream, _]
- def body[T, M <: MediaType](implicit tm: CodecForOptional[T, M, _]): Body[T, M, _]
- def clientIp: EndpointInput[Option[String]]
- Definition Classes
- TapirDerivedInputs
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def cookie[T](name: String)(implicit arg0: PlainCodecForOptional[T]): Cookie[T]
- def cookies: Header[List[Cookie]]
- def emptyOutput: EndpointOutput[Unit]
An empty output.
An empty output. Useful if one of
oneOf
branches should be mapped to the status code only. - val endpoint: Endpoint[Unit, Unit, Unit, Nothing]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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.
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formBody[T](implicit codec: CodecForOptional[T, XWwwFormUrlencoded, _]): Body[T, XWwwFormUrlencoded, _]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def header[T](name: String)(implicit arg0: PlainCodecForMany[T]): Header[T]
- def headers: Headers
- val htmlBodyUtf8: Body[String, TextHtml, String]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def jsonBody[T](implicit codec: CodecForOptional[T, Json, _]): Body[T, Json, _]
- def multipartBody[T](implicit codec: CodecForOptional[T, MultipartFormData, _]): Body[T, MultipartFormData, _]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def oneOf[I](firstCase: StatusMapping[_ <: I], otherCases: StatusMapping[_ <: I]*): OneOf[I]
Maps status codes to outputs.
Maps status codes to outputs. All outputs must have a common supertype (
I
). Typically, the supertype is a sealed trait, and the mappings are implementing cases classes.Note that exhaustiveness of the mappings is not checked (that all subtypes of
I
are covered). - def path[T](name: String)(implicit arg0: PlainCodec[T]): PathCapture[T]
- def path[T](implicit arg0: PlainCodec[T]): PathCapture[T]
- def paths: PathsCapture
- def plainBody[T](implicit codec: CodecForOptional[T, TextPlain, _]): Body[T, TextPlain, _]
- def query[T](name: String)(implicit arg0: PlainCodecForMany[T]): Query[T]
- def queryParams: QueryParams
- def schemaFor[T](implicit arg0: SchemaFor[T]): Schema
- def setCookie(name: String): Header[SetCookieValue]
- def setCookies: Header[List[SetCookie]]
- def statusCode(statusCode: StatusCode): FixedStatusCode
- def statusCode: StatusCode
- def statusDefaultMapping[O](output: EndpointOutput[O])(implicit arg0: ClassTag[O]): StatusMapping[O]
- def statusMapping[O](statusCode: StatusCode, output: EndpointOutput[O])(implicit arg0: ClassTag[O]): StatusMapping[O]
- def streamBody[S](schema: Schema, mediaType: MediaType): Body[S, mediaType.type]
- def stringBody(charset: Charset): Body[String, TextPlain, String]
- def stringBody(charset: String): Body[String, TextPlain, String]
- def stringBody: Body[String, TextPlain, String]
- implicit def stringToPath(s: String): EndpointInput[Unit]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()