http-rpc-api / net.corda.v5.httprpc.api.annotations / HttpRpcResource

HttpRpcResource

@Target([AnnotationTarget.CLASS]) annotation class HttpRpcResource

Marks an interface extending RPCOps to be exposed as an HTTP resource. The selected implementation to expose will be the same as for normal RPC.

Constructors

<init>

Marks an interface extending RPCOps to be exposed as an HTTP resource. The selected implementation to expose will be the same as for normal RPC.

HttpRpcResource(name: String = "", description: String = "", path: String = "")

Properties

description

The description of the resource, used for documentation. Defaults to empty string.

val description: String

name

The name of the resource, used for documentation. Defaults to the class name.

val name: String

path

The endpoint path of the resource. All exposed functions of the annotated class will have their path prepended with this. Defaults to the class name.

val path: String