trait Tapir extends TapirDerivedInputs with ModifyMacroSupport
- Alphabetic
- By Inheritance
- Tapir
- ModifyMacroSupport
- ModifyMacroFunctorSupport
- TapirDerivedInputs
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
implicit
class
ModifyEach[F[_], T] extends AnyRef
- Definition Classes
- ModifyMacroFunctorSupport
-
trait
ModifyFunctor[F[_], A] extends AnyRef
- Definition Classes
- ModifyMacroFunctorSupport
-
implicit
class
ModifyEachMap[F[_, _], K, T] extends AnyRef
- Definition Classes
- ModifyMacroSupport
-
trait
ModifyMapAtFunctor[F[_, _], K, T] extends AnyRef
- Definition Classes
- ModifyMacroSupport
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, CF <: CodecFormat](implicit tm: CodecForOptional[T, CF, _]): Body[T, CF, _]
-
def
clientIp: EndpointInput[Option[String]]
- Definition Classes
- TapirDerivedInputs
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @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: Any): 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[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[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def header(name: String, value: String): FixedHeader
- def header[T](name: String)(implicit arg0: PlainCodecForMany[T]): Header[T]
- def headers: Headers
- val htmlBodyUtf8: Body[String, TextHtml, String]
- val infallibleEndpoint: Endpoint[Unit, Nothing, Unit, Nothing]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def jsonBody[T](implicit codec: CodecForOptional[T, Json, _]): Body[T, Json, _]
-
implicit
def
mapModifyFunctor[M[KT, TT] <: Map[KT, TT], K, T](implicit cbf: CanBuildFrom[M[K, T], (K, T), M[K, T]]): ModifyMapAtFunctor[M, K, T]
- Definition Classes
- ModifyMacroSupport
- 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). -
implicit
def
optionModifyFunctor[A]: ModifyFunctor[Option, A]
- Definition Classes
- ModifyMacroFunctorSupport
- 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: Schema[T]): Schema[T]
- def setCookie(name: String): Header[CookieValueWithMeta]
- def setCookies: Header[List[CookieWithMeta]]
- def statusCode(statusCode: StatusCode): FixedStatusCode
- def statusCode: StatusCode
-
def
statusDefaultMapping[O](output: EndpointOutput[O])(implicit arg0: ClassTag[O]): StatusMapping[O]
Create a fallback mapping to be used in oneOf output descriptions.
-
def
statusMapping[O](statusCode: StatusCode, output: EndpointOutput[O])(implicit arg0: ClassTag[O]): StatusMapping[O]
Create a mapping to be used in oneOf output descriptions.
-
def
streamBody[S](schema: Schema[_], format: CodecFormat): Body[S, format.type]
- schema
Schema of the body. Note that any schema can be passed here, usually this will be a schema for the "deserialized" stream.
- format
The format of the stream body, which specifies its media 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
-
implicit
def
traversableModifyFunctor[F[_], A](implicit cbf: CanBuildFrom[F[A], A, F[A]], ev: (F[A]) ⇒ TraversableLike[A, F[A]]): ModifyFunctor[F, A]
- Definition Classes
- ModifyMacroSupport
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()