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

HttpRpcGET

@Target([AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER]) annotation class HttpRpcGET

Marks a function function of an @HttpRpcResource annotated interface to be exposed as a GET endpoint by the HTTP RPC generated web service.

Constructors

<init>

Marks a function function of an @HttpRpcResource annotated interface to be exposed as a GET endpoint by the HTTP RPC generated web service.

HttpRpcGET(path: String = "", title: String = "", description: String = "", responseDescription: String = "")

Properties

description

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

val description: String

path

The relative path of the endpoint within its resource. Defaults to the function name.

val path: String

responseDescription

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

val responseDescription: String

title

The title of the endpoint, used for documentation. Defaults to the function name.

val title: String