Bielu.AspNetCore.AsyncApi.Scalar.SignalR 1.0.0

Prefix Reserved
dotnet add package Bielu.AspNetCore.AsyncApi.Scalar.SignalR --version 1.0.0
                    
NuGet\Install-Package Bielu.AspNetCore.AsyncApi.Scalar.SignalR -Version 1.0.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="Bielu.AspNetCore.AsyncApi.Scalar.SignalR" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Bielu.AspNetCore.AsyncApi.Scalar.SignalR" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Bielu.AspNetCore.AsyncApi.Scalar.SignalR" />
                    
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 Bielu.AspNetCore.AsyncApi.Scalar.SignalR --version 1.0.0
                    
#r "nuget: Bielu.AspNetCore.AsyncApi.Scalar.SignalR, 1.0.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 Bielu.AspNetCore.AsyncApi.Scalar.SignalR@1.0.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=Bielu.AspNetCore.AsyncApi.Scalar.SignalR&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Bielu.AspNetCore.AsyncApi.Scalar.SignalR&version=1.0.0
                    
Install as a Cake Tool

Bielu.AspNetCore.AsyncApi.Scalar.SignalR

An interactive SignalR console for the Scalar API Reference in ASP.NET Core. It reads the signalr bindings in your AsyncAPI document and lets you connect to hubs, invoke methods and subscribe to server events — from the same page that documents them.

Installation

dotnet add package Bielu.AspNetCore.AsyncApi.Scalar.SignalR
dotnet add package Scalar.AspNetCore

Usage

app.MapScalarSignalRAssets();

app.MapScalarApiReference(options =>
{
    options.AddAsyncApiDocument("v1", "My API", "/asyncapi/v1.json");
    options.WithSignalRClient();
});

Requests are prefilled from your payload schemas (and from message examples, when the document declares them), and Scalar's configured authentication is passed through to the connection.

Using .NET Aspire? Install Bielu.AspNetCore.AsyncApi.Scalar.SignalR.Aspire instead, which adds the console to a Scalar resource from the AppHost.

Documentation

Feedback & Contributing

Released under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

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.