Class ApiRoutesOptions
Namespace: Cephalon.AspNetCore.Hosting
Assembly: Cephalon.AspNetCore.dll
Configures host-level HTTP route prefixes for Cephalon ASP.NET Core transports.
public sealed class ApiRoutesOptionsInheritance
Section titled “Inheritance”Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Remarks
Section titled “Remarks”These settings describe the public HTTP surface of the ASP.NET Core adapter. They intentionally stay out of the engine core.
Constructors
Section titled “Constructors”ApiRoutesOptions()
Section titled “ ApiRoutesOptions()”Initializes a new
public ApiRoutesOptions()Fields
Section titled “Fields”SectionName
Section titled “ SectionName”Gets the configuration section used for API route settings.
public const string SectionName = "ApiRoutes"Field Value
Section titled “Field Value”Properties
Section titled “Properties”DefaultBehaviorDocumentName
Section titled “ DefaultBehaviorDocumentName”Gets or sets the default document/version segment projected into generic behavior transport routes.
public string DefaultBehaviorDocumentName { get; set; }Property Value
Section titled “Property Value”GraphQLPrefix
Section titled “ GraphQLPrefix”Gets or sets the root prefix used by the built-in GraphQL transport mapper.
public string GraphQLPrefix { get; set; }Property Value
Section titled “Property Value”GraphQLSsePrefix
Section titled “ GraphQLSsePrefix”Gets or sets the canonical prefix used by the generic behavior GraphQL-over-SSE binding surface.
public string GraphQLSsePrefix { get; set; }Property Value
Section titled “Property Value”GraphQLWsPrefix
Section titled “ GraphQLWsPrefix”Gets or sets the canonical prefix used by the generic behavior GraphQL-over-WebSocket binding surface.
public string GraphQLWsPrefix { get; set; }Property Value
Section titled “Property Value”GrpcPrefix
Section titled “ GrpcPrefix”Gets or sets the root prefix used by the built-in gRPC transport mapper.
public string GrpcPrefix { get; set; }Property Value
Section titled “Property Value”JsonRpcPrefix
Section titled “ JsonRpcPrefix”Gets or sets the canonical prefix used by the generic behavior JSON-RPC binding surface.
public string JsonRpcPrefix { get; set; }Property Value
Section titled “Property Value”RestPrefix
Section titled “ RestPrefix”Gets or sets the root prefix used by the built-in REST transport mapper.
public string RestPrefix { get; set; }Property Value
Section titled “Property Value”SsePrefix
Section titled “ SsePrefix”Gets or sets the canonical prefix used by the generic behavior Server-Sent Events binding surface.
public string SsePrefix { get; set; }Property Value
Section titled “Property Value”UseResultModelEnvelope
Section titled “ UseResultModelEnvelope”Gets or sets a value indicating whether behavior-aware REST endpoints should emit the Cephalon result envelope.
public bool UseResultModelEnvelope { get; set; }Property Value
Section titled “Property Value”WsPrefix
Section titled “ WsPrefix”Gets or sets the canonical prefix used by the generic behavior WebSocket binding surface.
public string WsPrefix { get; set; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”FromConfiguration(IConfiguration, string)
Section titled “ FromConfiguration(IConfiguration, string)”Binds and normalizes API route settings from configuration.
public static ApiRoutesOptions FromConfiguration(IConfiguration configuration, string sectionPath = "ApiRoutes")Parameters
Section titled “Parameters”configuration IConfiguration
The application configuration root.
sectionPath string
The configuration section path to bind.
Returns
Section titled “Returns”The normalized route settings.