Automorph
API
Generated with
Automorph/automorph/automorph.protocol

automorph.protocol

package automorph.protocol

Members list

Packages

package automorph.protocol.jsonrpc
package automorph.protocol.webrpc

Type members

Classlikes

final case class JsonRpcProtocol[Node, Codec <: MessageCodec[Node], Context](messageCodec: Codec, mapError: (String, Int) => Throwable, mapException: Throwable => ErrorType, namedArguments: Boolean, mapOpenApi: OpenApi => OpenApi, mapOpenRpc: OpenRpc => OpenRpc, encodeMessage: (Message[Node]) => Node, decodeMessage: Node => Message[Node], encodeOpenRpc: OpenRpc => Node, encodeOpenApi: OpenApi => Node, encodeStrings: (List[String]) => Node) extends RpcProtocol[Node, Codec, Context]

JSON-RPC protocol plugin.

JSON-RPC protocol plugin.

Provides the following JSON-RPC methods for service discovery:

  • rpc.discover - API schema in OpenRPC format
  • 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

decodeMessage

converts a message format node to JSON-RPC message

encodeMessage

converts a JSON-RPC message to message format node

encodeOpenApi

converts an OpenAPI schema to message format node

encodeOpenRpc

converts an OpenRPC description to message format node

encodeStrings

converts a list of strings to message format node

mapError

maps a JSON-RPC error to a corresponding exception

mapException

maps an exception to a corresponding JSON-RPC error

mapOpenApi

transforms generated OpenAPI schema

mapOpenRpc

transforms generated OpenRPC schema

messageCodec

message codec plugin

namedArguments

if true, pass arguments by name, if false pass arguments by position

Attributes

Constructor

Creates a JSON-RPC protocol plugin.

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait RpcProtocol[Node, Codec, Context]
class Object
trait Matchable
class Any
Show all
object JsonRpcProtocol

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
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.

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

Constructor

Creates a Web-RPC 2.0 protocol implementation.

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait RpcProtocol[Node, Codec, Context]
class Object
trait Matchable
class Any
Show all
object WebRpcProtocol

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Generated with