Class BaseEndpoint

the base class all fast endpoints inherit from

Inheritance

object

BaseEndpoint

Endpoint<TRequest, TResponse>

Implements

IEndpoint

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: FastEndpoints

Assembly: FastEndpoints.dll

Syntax

public abstract class BaseEndpoint : IEndpoint

Properties

Definition

gets the endpoint definition which contains all the configuration info for the endpoint

Declaration

public EndpointDefinition Definition { get; }

Property Value

Type	Description
EndpointDefinition

HttpContext

the http context of the current request

Declaration

public HttpContext HttpContext { get; }

Property Value

Type	Description
HttpContext

ValidationFailures

validation failures collection for the endpoint

Declaration

public List<ValidationFailure> ValidationFailures { get; }

Property Value

Type	Description
List<ValidationFailure>

Methods

Configure()

use this method to configure how the endpoint should be listening to incoming requests.

HINT: it is only called once during endpoint auto registration during app startup.

Declaration

public virtual void Configure()

GetAclHash(string)

Declaration

protected static string GetAclHash(string input)

Parameters

Type	Name	Description
string	input

Returns

Type	Description
string

Group<TEndpointGroup>()

Declaration

protected virtual void Group<TEndpointGroup>() where TEndpointGroup : Group, new()

Type Parameters

Name	Description
TEndpointGroup

Routes(params string[])

Declaration

public virtual void Routes(params string[] patterns)

Parameters

Type	Name	Description
string[]	patterns

Verbs(params string[])

Declaration

public virtual void Verbs(params string[] methods)

Parameters

Type	Name	Description
string[]	methods

Implements

IEndpoint