Bielu.AspNetCore.AsyncApi.Attributes 1.0.0

Prefix Reserved
dotnet add package Bielu.AspNetCore.AsyncApi.Attributes --version 1.0.0
                    
NuGet\Install-Package Bielu.AspNetCore.AsyncApi.Attributes -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.Attributes" 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.Attributes" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Bielu.AspNetCore.AsyncApi.Attributes" />
                    
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.Attributes --version 1.0.0
                    
#r "nuget: Bielu.AspNetCore.AsyncApi.Attributes, 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.Attributes@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.Attributes&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Bielu.AspNetCore.AsyncApi.Attributes&version=1.0.0
                    
Install as a Cake Tool

Bielu.AspNetCore.AsyncApi.Attributes

The attributes used to describe AsyncAPI channels, operations, messages and parameters for Bielu.AspNetCore.AsyncApi.

This package is deliberately separate and free of ASP.NET Core dependencies, so a shared contracts assembly can be annotated without dragging the web stack into its dependency graph. The application that references Bielu.AspNetCore.AsyncApi then discovers those annotations at generation time.

Installation

dotnet add package Bielu.AspNetCore.AsyncApi.Attributes

Usage

[AsyncApi]
[Channel("light/measured")]
public class StreetlightMessageBus
{
    [PublishOperation(typeof(LightMeasuredEvent), Summary = "Inform about environmental lighting conditions.")]
    public void PublishLightMeasuredEvent(LightMeasuredEvent e) { }
}

Analyzers

The package also ships the BASYNC Roslyn analyzers, which catch attribute misuse that would otherwise fail silently at generation time — an operation attribute with no [Channel], a [Channel] on a type with no [AsyncApi], duplicate message names, malformed example JSON, and identifiers the AsyncAPI specification discourages.

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 (2)

Showing the top 2 NuGet packages that depend on Bielu.AspNetCore.AsyncApi.Attributes:

Package Downloads
Bielu.AspNetCore.AsyncApi

Code-first AsyncAPI document generation for ASP.NET Core. Describe channels, operations and messages with attributes or a fluent API, then serve the generated AsyncAPI 2.6 or 3.1 document from your app with MapAsyncApi() — or write it at build time. Supports XML doc comments, message examples, protocol bindings (SignalR, gRPC, SSE, WebRTC), multiple documents and Native AOT.

Bielu.AspNetCore.AsyncApi.UI

[DEPRECATED] Built-in AsyncAPI UI for Bielu.AspNetCore.AsyncApi. This package is deprecated — render the AsyncAPI document with Scalar instead (Scalar.AspNetCore + MapScalarApiReference), optionally with Bielu.AspNetCore.AsyncApi.Scalar.SignalR / .Scalar.Grpc for interactive protocol consoles.

GitHub repositories

This package is not used by any popular GitHub repositories.