Faactory.Canonical.AspNetCore 0.1.0

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package Faactory.Canonical.AspNetCore --version 0.1.0
                    


                    

                
NuGet\Install-Package Faactory.Canonical.AspNetCore -Version 0.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Faactory.Canonical.AspNetCore" Version="0.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Faactory.Canonical.AspNetCore" Version="0.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Faactory.Canonical.AspNetCore" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Faactory.Canonical.AspNetCore --version 0.1.0
                    


                    

                
#r "nuget: Faactory.Canonical.AspNetCore, 0.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Faactory.Canonical.AspNetCore@0.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Faactory.Canonical.AspNetCore&version=0.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Faactory.Canonical.AspNetCore&version=0.1.0
                    


                            Install as a Cake Tool

Canonical ASP.NET Core Integration

ASP.NET Core HTTP and WebSocket integration for Canonical API.

Setup

var builder = WebApplication.CreateBuilder( args );

builder.Services.AddCanonicalApi();

var app = builder.Build();

app.MapCanonical( "apps.deploy", DeployAsync );

HTTP

The application owns its routes and supplies the canonical endpoint name:

app.MapPost(
    "/apps/deploy",
    ( DeployRequest request, HttpContext context ) =>
        context.ExecuteCanonicalAsync( "apps.deploy", request )
);

The default HTTP writer supports one response or error. Canonical errors use ASP.NET Core Problem Details when it is registered, with JSON as the fallback.

WebSockets

app.UseWebSockets();

app.Map(
    "/canonical",
    context => context.RunCanonicalWebSocketAsync()
);

The built-in protocol supports concurrent requests, events, text streams, binary streams, responses, and errors.

Before builder.Build(), limits can be configured with CanonicalWebSocketOptions:

builder.Services.Configure<CanonicalWebSocketOptions>( options =>
{
    options.MaximumConcurrentRequests = 64;
    options.MaximumMessageSize = 1024 * 1024;
});

Custom WebSocket protocols

RunCanonicalWebSocketAsync() is the optional, opinionated protocol implementation.

For a different wire format, accept and parse the WebSocket in the application, implement ICanonicalApiWriter, and execute each request directly:

await context.ExecuteCanonicalAsync(
    name,
    requestId,
    payload,
    writer,
    cancellationToken
);

The application owns message parsing, framing, correlation, and socket lifetime. The canonical runtime remains unchanged.

WebSocket protocol

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.0 107 8/27/2026