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

Bielu.Arazzo.NET

Object model, writers and validation for the Arazzo Specification — the OpenAPI Initiative's format for describing workflows across API calls.

Arazzo 1.1.0 added AsyncAPI as a first-class sourceDescriptions type, which makes it the only standard way to describe a workflow that spans HTTP requests and event/message channels.

This package is framework-free — no ASP.NET Core dependency, and no dependency on anything else in the suite — so tooling, generators and applications can all consume it.

Installation

dotnet add package Bielu.Arazzo.NET

What's in it

  • The full model: ArazzoDocument, ArazzoWorkflow, ArazzoStep (including the AsyncAPI-specific ChannelPath, Action and CorrelationId fields new in 1.1), ArazzoCriterion, and the rest.
  • JSON and YAML writers over a shared JsonNode tree builder.
  • A runtime-expression parser and evaluator for the full §5.9 grammar ($inputs.*, $steps.*, $response.*, $message.*, …).
  • ArazzoValidator for the specification's structural invariants.

To read documents, add Bielu.Arazzo.NET.Readers.

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

Showing the top 2 NuGet packages that depend on Bielu.Arazzo.NET:

Package Downloads
Bielu.AspNetCore.Arazzo

ASP.NET Core integration for Bielu.Arazzo.NET: fluent workflow authoring, MapArazzo() document serving, and self-wiring source-description resolution against an app's own live AsyncAPI/OpenAPI documents.

Bielu.Arazzo.NET.Readers

JSON and YAML readers for the Arazzo Specification (OpenAPI workflows), producing Bielu.Arazzo.NET documents with diagnostics.

GitHub repositories

This package is not used by any popular GitHub repositories.