Class ApiEndpointOptions

Namespace

Cratis.Arc

Assembly

Cratis.Arc.Core.dll

Represents the options for API endpoints.

public class ApiEndpointOptions

Inheritance

object

ApiEndpointOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

MethodCalls.CallGenericMethod<TOut, T>(T, Expression<Func<T, Func<TOut>>>, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1>(T, Expression<Func<T, Func<T1, TOut>>>, T1, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2>(T, Expression<Func<T, Func<T1, T2, TOut>>>, T1, T2, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2, T3>(T, Expression<Func<T, Func<T1, T2, T3, TOut>>>, T1, T2, T3, params Type[])

ConverterExtensions.ConvertTo(object, Type)

ConceptExtensions.GetConceptValue(object)

ConceptExtensions.IsConcept(object)

JsonValueExtensions.ToJsonValue(object?)

ObservableExtensions.InvokeAndWrapWithSubject<TResult>(object, Func<CancellationToken, IObservable<TResult>>)

ObservableExtensions.InvokeAndWrapWithTransformSubject<TResult, TSource>(object, Func<CancellationToken, IObservable<TSource>>, Func<TSource, TResult>)

Constructors

ApiEndpointOptions()

public ApiEndpointOptions()

Properties

EnableQueryHttpMethod

Whether to expose queries over the HTTP QUERY method (RFC 10008) in addition to GET.

public bool EnableQueryHttpMethod { get; set; }

Property Value

bool

Remarks

When enabled (the default), every generated query endpoint also accepts the QUERY method, carrying its arguments in a JSON request body instead of the query string. Disable this to restrict query endpoints to GET only — for example behind infrastructure that rejects unknown HTTP verbs.

IncludeCommandNameInRoute

Whether to include the command name as the last segment of the route.

public bool IncludeCommandNameInRoute { get; set; }

Property Value

bool

IncludeQueryNameInRoute

Whether to include the query name as the last segment of the route.

public bool IncludeQueryNameInRoute { get; set; }

Property Value

bool

RoutePrefix

Gets or sets the route prefix to use for endpoints.

public string RoutePrefix { get; set; }

Property Value

string

SegmentsToSkipForRoute

Number of segments to skip from the start of the type's namespace when constructing the route.

public int SegmentsToSkipForRoute { get; set; }

Property Value

int