WebRpcProtocol

automorph.protocol.WebRpcProtocol
See theWebRpcProtocol companion class

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Type members

Inherited types

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

Creates a Web-RPC protocol plugin.

Creates a Web-RPC protocol plugin.

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

codec

message codec plugin

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

pathPrefix

API path prefix

Attributes

Returns

Web-RPC protocol plugin

See also

Inherited methods

Maps a Web-RPC error to a corresponding default exception.

Maps a Web-RPC error to a corresponding default exception.

Value parameters

code

error code

message

error message

Attributes

Returns

exception

Inherited from:
ErrorMapping (hidden)

Maps an exception to a corresponding default Web-RPC error type.

Maps an exception to a corresponding default Web-RPC error type.

Value parameters

exception

exception

Attributes

Returns

Web-RPC error type

Inherited from:
ErrorMapping (hidden)

Concrete fields

Service discovery method providing API schema in OpenAPI format.

Service discovery method providing API schema in OpenAPI format.

Attributes