Interface IHttpFunctionBuilder

Interface that allows for the configuration of HTTP triggered functions

Namespace: FunctionMonkey.Abstractions.Builders

Assembly: FunctionMonkey.Abstractions.dll

Syntax

public interface IHttpFunctionBuilder

Methods

HttpFunction<TCommand>()

Associate a GET verb function with the given command. Its endpoint will be that specified by the parent HTTP route and with the default authorization type (see IAuthorizationBuilder)

Declaration

IHttpFunctionConfigurationBuilder<TCommand> HttpFunction<TCommand>()

Returns

Type	Description
IHttpFunctionConfigurationBuilder<TCommand>	A IHttpFunctionConfigurationBuilder that allows further HTTP functions to be created and this function to be further configured with Open API / Swagger metadata.

Type Parameters

Name	Description
TCommand	The command type

HttpFunction<TCommand>(AuthorizationTypeEnum)

Associate a GET verb function with the given command type and authorization type. Its endpoint will be that specified by the parent HTTP route.

Declaration

IHttpFunctionConfigurationBuilder<TCommand> HttpFunction<TCommand>(AuthorizationTypeEnum authorizationType)

Parameters

Type	Name	Description
AuthorizationTypeEnum	authorizationType	The authorization type of the function

Returns

Type	Description
IHttpFunctionConfigurationBuilder<TCommand>	A IHttpFunctionConfigurationBuilder that allows further HTTP functions to be created and this function to be further configured with Open API / Swagger metadata.

Type Parameters

Name	Description
TCommand	The command type

HttpFunction<TCommand>(AuthorizationTypeEnum, HttpMethod[])

Associate a function with the given command type, authorization type and HTTP verbs. Its endpoint will be that specified by the parent HTTP route.

Declaration

IHttpFunctionConfigurationBuilder<TCommand> HttpFunction<TCommand>(AuthorizationTypeEnum authorizationType, params HttpMethod[] method)

Parameters

Type	Name	Description
AuthorizationTypeEnum	authorizationType	The authorization type of the function
HttpMethod[]	method	One or more HTTP methods to support.

Returns

Type	Description
IHttpFunctionConfigurationBuilder<TCommand>	A IHttpFunctionConfigurationBuilder that allows further HTTP functions to be created and this function to be further configured with Open API / Swagger metadata.

Type Parameters

Name	Description
TCommand	The command type

HttpFunction<TCommand>(HttpMethod[])

Assocate a function with the given command type and associate it with the specified verbs. Its endpoint will be that specified by the parent HTTP route and with the default authorization type (see IAuthorizationBuilder)

Declaration

IHttpFunctionConfigurationBuilder<TCommand> HttpFunction<TCommand>(params HttpMethod[] method)

Parameters

Type	Name	Description
HttpMethod[]	method	One or more HTTP methods to support.

Returns

Type	Description
IHttpFunctionConfigurationBuilder<TCommand>	A IHttpFunctionConfigurationBuilder that allows further HTTP functions to be created and this function to be further configured with Open API / Swagger metadata.

Type Parameters

Name	Description
TCommand

HttpFunction<TCommand>(String, AuthorizationTypeEnum, HttpMethod[])

Assocate a function with the given command type and associate it with the specified verbs. Its endpoint will be that specified by the parent HTTP route concatenated with the parent route specified here and it will be secured by the specified authorization type.

Declaration

IHttpFunctionConfigurationBuilder<TCommand> HttpFunction<TCommand>(string route, AuthorizationTypeEnum authorizationType, params HttpMethod[] method)

Parameters

Type	Name	Description
System.String	route	The route to concatenate with the parent route
AuthorizationTypeEnum	authorizationType	The authorization type of the function
HttpMethod[]	method	One or more HTTP methods to support.

Returns

Type	Description
IHttpFunctionConfigurationBuilder<TCommand>	A IHttpFunctionConfigurationBuilder that allows further HTTP functions to be created and this function to be further configured with Open API / Swagger metadata.

Type Parameters

Name	Description
TCommand	The command type

HttpFunction<TCommand>(String, HttpMethod[])

Assocate a function with the given command type and associate it with the specified verbs. Its endpoint will be that specified by the parent HTTP route concatenated with the parent route specified here and it will be secured with the default authorization type (see IAuthorizationBuilder)

Declaration

IHttpFunctionConfigurationBuilder<TCommand> HttpFunction<TCommand>(string route, params HttpMethod[] method)

Parameters

Type	Name	Description
System.String	route	The route to concatenate with the parent route
HttpMethod[]	method	One or more HTTP methods to support.

Returns

Type	Description
IHttpFunctionConfigurationBuilder<TCommand>	A IHttpFunctionConfigurationBuilder that allows further HTTP functions to be created and this function to be further configured with Open API / Swagger metadata.

Type Parameters

Name	Description
TCommand	The command type

Extension Methods

OpenApiFluentValidationHelper.IsNumeric(Object)

OpenApiFluentValidationHelper.NumericToInt(Object)

OpenApiFluentValidationHelper.NumericToDouble(Object)

OpenApiFluentValidationHelper.NumericToDecimal(Object)