Bielu.AspNetCore.Arazzo 1.0.0

Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Bielu.AspNetCore.Arazzo --version 1.0.0
                    
NuGet\Install-Package Bielu.AspNetCore.Arazzo -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.Arazzo" 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.Arazzo" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Bielu.AspNetCore.Arazzo" />
                    
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.Arazzo --version 1.0.0
                    
#r "nuget: Bielu.AspNetCore.Arazzo, 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.Arazzo@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.Arazzo&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Bielu.AspNetCore.Arazzo&version=1.0.0
                    
Install as a Cake Tool

Bielu.AspNetCore.Arazzo

ASP.NET Core integration for Bielu.Arazzo.NET: author Arazzo workflows with a fluent builder, serve them from your app, and have their references checked against the documents that same app produces.

Installation

dotnet add package Bielu.AspNetCore.Arazzo

Usage

builder.Services.AddArazzo(options =>
{
    options.WithInfo("Streetlights workflows", "1.0.0");

    options.AddWorkflow("measureAndAlert", wf => wf
        .Step("publishMeasurement", s => s
            .Operation("$sourceDescriptions.events.sendLightMeasurement")
            .Output("measurementId", "$message.payload#/id")));
});

var app = builder.Build();

app.MapArazzo();   // -> /arazzo/{documentName}.json | .yaml

Cross-spec reference validation

The differentiating feature: sourceDescriptions can be resolved against the live documents of the same application — its AsyncAPI documents and its Microsoft.AspNetCore.OpenApi document — so every operationId and channelPath a step references is checked at startup rather than failing in production. Rename a channel and the app fails to start, instead of the workflow silently pointing at nothing.

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

Showing the top 1 NuGet packages that depend on Bielu.AspNetCore.Arazzo:

Package Downloads
Bielu.AspNetCore.Arazzo.Overlay

Applies OpenAPI Overlays to Arazzo workflow documents inside the generation pipeline, so the document served by MapArazzo() is already transformed — no post-processing step and no second artifact to keep in sync.

GitHub repositories

This package is not used by any popular GitHub repositories.