Interface IHttpFunctionConfigurationBuilder<TCommand>

Allows for additional HTTP function configuration including Open API and header bindings

Inherited Members
Namespace: FunctionMonkey.Abstractions.Builders
Assembly: FunctionMonkey.Abstractions.dll
Syntax
public interface IHttpFunctionConfigurationBuilder<TCommand> : IHttpFunctionBuilder, IFunctionOptions<IHttpFunctionConfigurationBuilder<TCommand>, IHttpFunctionOptionsBuilder<TCommand>>
Type Parameters
Name Description
TCommand

Methods

| Improve this Doc View Source

OpenApiDescription(String)

The Open API / Swagger description for the endpoint

Declaration
IHttpFunctionConfigurationBuilder<TCommand> OpenApiDescription(string description)
Parameters
Type Name Description
System.String description

The description
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.
| Improve this Doc View Source

OpenApiResponse(Int32, String, Type)

The Open API / Swagger description for the endpoint and specific response code

Declaration
IHttpFunctionConfigurationBuilder<TCommand> OpenApiResponse(int httpStatusCode, string description, Type responseType = null)
Parameters
Type Name Description
System.Int32 httpStatusCode

The HTTP status code
System.String description

The description
Type responseType

The type of the response object. Optional
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.
| Improve this Doc View Source

OpenApiSummary(String)

The Open API / Swagger summary for the endpoint

Declaration
IHttpFunctionConfigurationBuilder<TCommand> OpenApiSummary(string summary)
Parameters
Type Name Description
System.String summary

The summary
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.

Extension Methods