ApiMethodAttribute

constructor

ApiMethodAttribute()

Sub New()

HTTP method that will be used to call the service. By default the POST method is used.

property HttpApiMethod: ApiRequestMethod read write;

ApiRequestMethod HttpApiMethod { get; set; }

Property HttpApiMethod() As ApiRequestMethod

custom operation name that can be used by the client code codegen instead of operation name that was auto-generated based on the API method path and Http method. For obvious reasons this operation name should be unique server-wide.

property HttpApiOperationId: String read write;

String HttpApiOperationId { get; set; }

Property HttpApiOperationId() As String

The url template that can be used to call the service method. The path parts in the curly braces {} are bindings of the method parameters. When the method is called the corresponding part of the Url is extracted and provided as the service method parameter value.

Note: Only parameters of string, number, boolean, enumeration type can be bound via api method path.

property HttpApiPath: String read write;

String HttpApiPath { get; set; }

Property HttpApiPath() As String

Name of the wrapper method parameters structure. By default server metainformation describes method parameters as a structure named {ServiceName}{MethodName}Request (f.e. LoginServiceLoginRequest). This optional parameter allows to override the auto-generated wrapper name. Redefined wrapper name should be unique server-wide.

property HttpApiRequestName: String read write;

String HttpApiRequestName { get; set; }

Property HttpApiRequestName() As String

HTTP response code that will be sent back to the client on successful method execution. By default the response will have the 200 OK Http code.

property HttpApiResult: HttpStatusCode read write;

HttpStatusCode HttpApiResult { get; set; }

Property HttpApiResult() As HttpStatusCode

string array containing a list of tags that are applied to the service method. These tags are exposed via OpenAPI description file and are used by some codegens (f.e. the Swagger one) to group method proxies in the generated code.

property HttpApiTags: array of String read write;

String[] HttpApiTags { get; set; }

Property HttpApiTags() As String()

property Name: String read write;

String Name { get; set; }

Property Name() As String

HTTP method that will be used to call the service. By default the POST method is used.

property HttpApiMethod: ApiRequestMethod read write;

ApiRequestMethod HttpApiMethod { get; set; }

Property HttpApiMethod() As ApiRequestMethod

custom operation name that can be used by the client code codegen instead of operation name that was auto-generated based on the API method path and Http method. For obvious reasons this operation name should be unique server-wide.

property HttpApiOperationId: String read write;

String HttpApiOperationId { get; set; }

Property HttpApiOperationId() As String

The url template that can be used to call the service method. The path parts in the curly braces {} are bindings of the method parameters. When the method is called the corresponding part of the Url is extracted and provided as the service method parameter value.

Note: Only parameters of string, number, boolean, enumeration type can be bound via api method path.

property HttpApiPath: String read write;

String HttpApiPath { get; set; }

Property HttpApiPath() As String

Name of the wrapper method parameters structure. By default server metainformation describes method parameters as a structure named {ServiceName}{MethodName}Request (f.e. LoginServiceLoginRequest). This optional parameter allows to override the auto-generated wrapper name. Redefined wrapper name should be unique server-wide.

property HttpApiRequestName: String read write;

String HttpApiRequestName { get; set; }

Property HttpApiRequestName() As String

HTTP response code that will be sent back to the client on successful method execution. By default the response will have the 200 OK Http code.

property HttpApiResult: HttpStatusCode read write;

HttpStatusCode HttpApiResult { get; set; }

Property HttpApiResult() As HttpStatusCode

string array containing a list of tags that are applied to the service method. These tags are exposed via OpenAPI description file and are used by some codegens (f.e. the Swagger one) to group method proxies in the generated code.

property HttpApiTags: array of String read write;

String[] HttpApiTags { get; set; }

Property HttpApiTags() As String()

property Name: String read write;

String Name { get; set; }

Property Name() As String