final case class TapirHttpEndpoint[Effect[_]](effectSystem: EffectSystem[Effect], pathPrefix: String = "/", method: Option[HttpMethod] = None, mapException: (Throwable) => Int = HttpContext.defaultExceptionToStatusCode, handler: RequestHandler[Effect, Context] = RequestHandler.dummy[Effect, Context]) extends Logging with EndpointTransport[Effect, Context, Full[Unit, Unit, Request, Unit, (Array[Byte], StatusCode), Any, Effect]] with Product with Serializable
Tapir HTTP endpoint message transport plugin.
Interprets HTTP request body as an RPC request and processes it using the specified RPC request handler.
- The response returned by the RPC request handler is used as HTTP response body.
- Effect
effect type
- effectSystem
effect system plugin
- pathPrefix
HTTP URL path prefix, only requests starting with this path prefix are allowed
- method
allowed HTTP method, all methods are allowed if empty
- mapException
maps an exception to a corresponding HTTP status code
- handler
RPC request handler
- See also
- Alphabetic
- By Inheritance
- TapirHttpEndpoint
- Serializable
- Product
- Equals
- EndpointTransport
- Logging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new TapirHttpEndpoint(effectSystem: EffectSystem[Effect], pathPrefix: String = "/", method: Option[HttpMethod] = None, mapException: (Throwable) => Int = HttpContext.defaultExceptionToStatusCode, handler: RequestHandler[Effect, Context] = RequestHandler.dummy[Effect, Context])
Creates a Tapir HTTP endpoint message transport plugin with specified effect system and request handler.
Creates a Tapir HTTP endpoint message transport plugin with specified effect system and request handler.
- effectSystem
effect system plugin
- pathPrefix
HTTP URL path prefix, only requests starting with this path prefix are allowed
- method
allowed HTTP method, all methods are allowed if empty
- mapException
maps an exception to a corresponding HTTP status code
- handler
RPC request handler
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
- def adapter: Full[Unit, Unit, Request, Unit, (Array[Byte], StatusCode), Any, Effect]
- Definition Classes
- TapirHttpEndpoint → EndpointTransport
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val effectSystem: EffectSystem[Effect]
- Definition Classes
- TapirHttpEndpoint → EndpointTransport
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val handler: RequestHandler[Effect, Context]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val logger: Logger
- Attributes
- protected
- Definition Classes
- Logging
- val mapException: (Throwable) => Int
- val method: Option[HttpMethod]
- 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()
- val pathPrefix: String
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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()
- def withHandler(handler: RequestHandler[Effect, Context]): TapirHttpEndpoint[Effect]
- Definition Classes
- TapirHttpEndpoint → EndpointTransport