Bielu.AspNetCore.Arazzo.Scalar.Aspire 3.1.1

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.Scalar.Aspire --version 3.1.1
                    
NuGet\Install-Package Bielu.AspNetCore.Arazzo.Scalar.Aspire -Version 3.1.1
                    
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.Scalar.Aspire" Version="3.1.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Bielu.AspNetCore.Arazzo.Scalar.Aspire" Version="3.1.1" />
                    
Directory.Packages.props
<PackageReference Include="Bielu.AspNetCore.Arazzo.Scalar.Aspire" />
                    
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.Scalar.Aspire --version 3.1.1
                    
#r "nuget: Bielu.AspNetCore.Arazzo.Scalar.Aspire, 3.1.1"
                    
#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.Scalar.Aspire@3.1.1
                    
#: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.Scalar.Aspire&version=3.1.1
                    
Install as a Cake Addin
#tool nuget:?package=Bielu.AspNetCore.Arazzo.Scalar.Aspire&version=3.1.1
                    
Install as a Cake Tool

Bielu.AspNetCore.Arazzo.Scalar.Aspire

Renders Arazzo workflows in a Scalar.Aspire API Reference resource from your .NET Aspire AppHost, next to the OpenAPI and AsyncAPI documents their steps call.

Installation

dotnet add package Bielu.AspNetCore.Arazzo.Scalar.Aspire

Usage

var api = builder.AddProject<Projects.MyApi>("api");   // serves /arazzo/v1.json with MapArazzo()

builder.AddScalarApiReference()
    .WithArazzo()
    .WithApiReference(api, options => options
        .AddDocument("v1")                              // the OpenAPI document the steps call
        .AddArazzoDocument("v1", "Workflows"));         // /arazzo/{documentName}.json by default

WithArazzo registers the @bielu/scalar-arazzo plugin through Scalar's PluginUrls option, which loads it as an ES module before the API Reference mounts. The Scalar container keeps its own bundle and only the plugin is added, so it combines with the SignalR and gRPC consoles on the same resource.

By default the plugin is loaded from jsDelivr, pinned to the exact npm version released alongside this package. Pass pluginUrl: to load it from somewhere else.

Requires @scalar/api-reference 1.80.0 or later in the Scalar container image, the first release with plugin document types. Older images show an Arazzo source as an empty OpenAPI document.

Documentation

Feedback & Contributing

Copyright (c) 2025 Arkadiusz Biel. 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.  net11.0 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
3.2.0-beta.20261121112417 0 11/21/2026
3.2.0-beta.20261121095737 0 11/21/2026
3.1.1 66 11/19/2026
3.1.0-beta.20261118231732 39 11/18/2026
3.1.0-beta.20261118231308 43 11/18/2026
3.1.0-beta.20261118222254 36 11/18/2026
3.1.0-beta.20261118211818 45 11/18/2026
3.1.0-beta.20261118140020 46 11/18/2026
3.1.0-beta.20261118135948 40 11/18/2026