Interface IHttpRouteFunctionBuilder

Used to optionally annotate a function with metadata for Open API

Inherited Members
Namespace: FunctionMonkey.Abstractions.Builders
Assembly: FunctionMonkey.Abstractions.dll
Syntax
public interface IHttpRouteFunctionBuilder : IFunctionBuilder, ITimerFunctionBuilder

Methods

| Improve this Doc View Source

OpenApiDescription(String)

The Open API / Swagger description for the endpoint

Declaration
IHttpRouteFunctionBuilder OpenApiDescription(string description)
Parameters
Type Name Description
System.String description

The description
Returns
Type Description
IHttpRouteFunctionBuilder

A IHttpRouteFunctionBuilder that allows further functions to be created and this route to be further configured with Open API / Swagger metadata.
| Improve this Doc View Source

OpenApiName(String)

The Open API / Swagger name for the route

Declaration
IHttpRouteFunctionBuilder OpenApiName(string name)
Parameters
Type Name Description
System.String name

The name
Returns
Type Description
IHttpRouteFunctionBuilder

A IHttpRouteFunctionBuilder that allows further functions to be created and this route to be further configured with Open API / Swagger metadata.
| Improve this Doc View Source

Options(Action<IHttpRouteOptionsBuilder>)

Allow options to be configured for the route

Declaration
IHttpRouteFunctionBuilder Options(Action<IHttpRouteOptionsBuilder> options)
Parameters
Type Name Description
Action<IHttpRouteOptionsBuilder> options
Returns
Type Description
IHttpRouteFunctionBuilder

Extension Methods