Bielu.AspNetCore.AsyncApi.ApiDescription.Server 1.0.0

Prefix Reserved 
dotnet add package Bielu.AspNetCore.AsyncApi.ApiDescription.Server --version 1.0.0
                    


                    

                
NuGet\Install-Package Bielu.AspNetCore.AsyncApi.ApiDescription.Server -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.ApiDescription.Server" 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.ApiDescription.Server" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Bielu.AspNetCore.AsyncApi.ApiDescription.Server" />
                    


                            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.ApiDescription.Server --version 1.0.0
                    


                    

                
#r "nuget: Bielu.AspNetCore.AsyncApi.ApiDescription.Server, 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.ApiDescription.Server@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.ApiDescription.Server&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Bielu.AspNetCore.AsyncApi.ApiDescription.Server&version=1.0.0
                    


                            Install as a Cake Tool

Bielu.AspNetCore.AsyncApi.ApiDescription.Server

MSBuild targets that generate your AsyncAPI document at build time, so it can be committed to the repository, reviewed in a pull request, and diffed in CI.

The equivalent of Microsoft.Extensions.ApiDescription.Server for AsyncAPI.

Installation

dotnet add package Bielu.AspNetCore.AsyncApi.ApiDescription.Server

Usage

Referencing the package is enough — the document is written on build. Control it with MSBuild properties:

<PropertyGroup>
  <AsyncApiGenerateDocuments>true</AsyncApiGenerateDocuments>
  <AsyncApiDocumentsDirectory>$(MSBuildProjectDirectory)/asyncapi</AsyncApiDocumentsDirectory>
</PropertyGroup>

Generation runs the same pipeline the runtime endpoint uses, so a checked-in document and the one served from /asyncapi/{documentName}.json cannot disagree.

Documentation

Feedback & Contributing

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

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.