automorph.protocol.WebRpcProtocol
See theWebRpcProtocol companion object
final case class WebRpcProtocol[Node, Codec <: MessageCodec[Node], Context <: HttpContext[_]](messageCodec: Codec, pathPrefix: String, mapError: (String, Option[Int]) => Throwable, mapException: Throwable => ErrorType, mapOpenApi: OpenApi => OpenApi, encodeRequest: (Request[Node]) => Node, decodeRequest: Node => Request[Node], encodeResponse: (Message[Node]) => Node, decodeResponse: Node => Message[Node], encodeOpenApi: OpenApi => Node, encodeString: String => Node) extends RpcProtocol[Node, Codec, Context]
Web-RPC protocol implementation.
Provides the following Web-RPC functions for service discovery:
api.discover- API schema in OpenAPI format
Type parameters
- Codec
-
message codec plugin type
- Context
-
RPC message context type
- Node
-
message node type
Value parameters
- decodeRequest
-
converts a message format node to Web-RPC request
- decodeResponse
-
converts a message format node to Web-RPC response
- encodeOpenApi
-
converts an OpenAPI schema to message format node
- encodeRequest
-
converts a Web-RPC request to message format node
- encodeResponse
-
converts a Web-RPC response to message format node
- encodeString
-
converts a string to message format node
- mapError
-
maps a Web-RPC error to a corresponding exception
- mapException
-
maps an exception to a corresponding Web-RPC error
- mapOpenApi
-
transforms generated OpenAPI schema
- messageCodec
-
message codec plugin
- pathPrefix
-
API path prefix
Attributes
Members list
In this article