Bielu.AspNetCore.AsyncApi.Cli 1.0.0

Prefix Reserved
dotnet tool install --global Bielu.AspNetCore.AsyncApi.Cli --version 1.0.0
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local Bielu.AspNetCore.AsyncApi.Cli --version 1.0.0
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Bielu.AspNetCore.AsyncApi.Cli&version=1.0.0
                    
nuke :add-package Bielu.AspNetCore.AsyncApi.Cli --version 1.0.0
                    

Bielu.AspNetCore.AsyncApi.Cli

dotnet asyncapi — a .NET tool for working with the AsyncAPI documents your application produces.

Installation

dotnet tool install --global Bielu.AspNetCore.AsyncApi.Cli

Commands

# Generate documents from a built ASP.NET Core assembly
dotnet asyncapi getdocument --assembly MyApi --assembly-path ./bin/Release/net10.0/MyApi.dll --output ./docs

# Validate one or more documents (--strict also fails on warnings)
dotnet asyncapi validate --file asyncapi.json --strict --format json

# Compare two documents and fail the build on a breaking change
dotnet asyncapi diff --base old.json --head new.json --fail-on-breaking --format markdown

# Merge documents from several services into one
dotnet asyncapi merge --source a.json --source b.json --output merged.json

validate and diff exit non-zero on failure, so they drop straight into CI. diff classifies a removed channel, operation or message — and any narrowing of a payload schema — as breaking.

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.

This package has no dependencies.