Interface IEndpoint
the common interface implemented by all endpoints
Assembly: FastEndpoints.dll
Syntax
public interface IEndpoint
Properties
Definition
gets the endpoint definition which contains all the configuration info for the endpoint
Declaration
EndpointDefinition Definition { get; }
Property Value
HttpContext
the http context of the current request
Declaration
HttpContext HttpContext { get; }
Property Value
TestUrlCache
Declaration
public static ConcurrentDictionary<Type, string> TestUrlCache { get; }
Property Value
ValidationFailures
validation failures collection for the endpoint
Declaration
List<ValidationFailure> ValidationFailures { get; }
Property Value
| Type |
Description |
| List<ValidationFailure> |
|
Methods
GetName<TEndpoint>(Http?, int?, string?)
retrieves the name of a given endpoint by supplying its type. the name is generated using the NameGenerator func.
Declaration
public static string GetName<TEndpoint>(Http? verb = null, int? routeNumber = null, string? tagPrefix = null) where TEndpoint : IEndpoint
Parameters
| Type |
Name |
Description |
| Http? |
verb |
the http verb, if the target is a multi-verb endpoint.
|
| int? |
routeNumber |
the route number, if the target is a multi route endpoint.
|
| string |
tagPrefix |
tag prefix
|
Returns
Type Parameters
| Name |
Description |
| TEndpoint |
|
TestURLFor<TEndpoint>()
Declaration
public static string TestURLFor<TEndpoint>()
Returns
Type Parameters
| Name |
Description |
| TEndpoint |
|