Bielu.AspNetCore.AsyncApi.Cli 1.4.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

• CLI reference
• Full documentation

Feedback & Contributing

Copyright (c) 2025 Arkadiusz Biel. Released under the MIT license. Bug reports and contributions are welcome at the GitHub repository.