TapirHttpEndpoint

automorph.transport.http.endpoint.TapirHttpEndpoint

See theTapirHttpEndpoint companion object

final case class TapirHttpEndpoint[Effect[_]](effectSystem: EffectSystem[Effect], pathPrefix: String, method: Option[HttpMethod], mapException: Throwable => Int, handler: RequestHandler[Effect, Context]) extends EndpointTransport[Effect, Context, Full[Unit, Unit, Request, Unit, (Array[Byte], StatusCode), Any, Effect]]

Tapir HTTP endpoint message transport plugin.

Interprets HTTP request body as an RPC request and processes it using the specified RPC request handler.

Type parameters

effectSystem: effect system plugin
handler: RPC request handler
mapException: maps an exception to a corresponding HTTP status code
method: allowed HTTP method, all methods are allowed if empty
pathPrefix: HTTP URL path prefix, only requests starting with this path prefix are allowed

Constructor: Creates a Tapir HTTP endpoint message transport plugin with specified effect system and request handler.
See also: Transport protocol

Library documentation

API
Companion: object
Graph
Supertypes: trait Serializable

trait Product

trait Equals

trait EndpointTransport[Effect, Context, Full[Unit, Unit, Request, Unit, (Array[Byte], StatusCode), Any, Effect]]

class Object

trait Matchable

class Any
Show all

Transport layer adapter.

Create a copy of this endpoint transport with specified RPC request handler.

In this article

Generated with