AsyncAPI.NET 6.0.0-beta.91

This is a prerelease version of AsyncAPI.NET.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package AsyncAPI.NET --version 6.0.0-beta.91                
NuGet\Install-Package AsyncAPI.NET -Version 6.0.0-beta.91                
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="AsyncAPI.NET" Version="6.0.0-beta.91" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AsyncAPI.NET --version 6.0.0-beta.91                
#r "nuget: AsyncAPI.NET, 6.0.0-beta.91"                
#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.
// Install AsyncAPI.NET as a Cake Addin
#addin nuget:?package=AsyncAPI.NET&version=6.0.0-beta.91&prerelease

// Install AsyncAPI.NET as a Cake Tool
#tool nuget:?package=AsyncAPI.NET&version=6.0.0-beta.91&prerelease                

alternate text is missing from this package README image

AsyncAPI.NET

GitHub Workflow Status

The AsyncAPI.NET SDK contains a useful object model for the AsyncAPI specification in .NET along with common serializers to extract raw AsyncAPI JSON and YAML documents from the model as well.

CHANGELOG
Wiki and getting started guide

Installation

Install the NuGet packages:

AsyncAPI.NET

Nuget
Nuget

AsyncAPI.Readers

Nuget
Nuget

AsyncAPI.Bindings

Nuget

Example Usage

Main classes to know:

  • AsyncApiStringReader
  • AsyncApiStringWriter
    • There is an extension on the AsyncApiDocument type which allows Serializing as well (new AsyncApiDocument().SerializeAsJson() or new AsyncApiDocument().SerializeAsYaml()

Writing

var myFirstAsyncApi = new AsyncApiDocument
{
  Info = new AsyncApiInfo
  {
    Title = "my first asyncapi"
  },
  Channels = new Dictionary<string, AsyncApiChannel>
  {
    {
	"users", new AsyncApiChannel
	{
	    Subscribe = new AsyncApiOperation
	    {
		OperationId = "users",
		Description = "my users channel"
	    }
	}
    }
  }
};
var yaml = myFirstAsyncApi.SerializeAsYaml();
//asyncapi: '2.5.0'
//  info:
//    title: my first asyncapi
//  channels:
//    users:
//      subscribe:
//        operationId: users
//        description: my users channel

Reading

var httpClient = new HttpClient
{
  BaseAddress = new Uri("https://raw.githubusercontent.com/asyncapi/spec/"),
};

var stream = await httpClient.GetStreamAsync("master/examples/streetlights-kafka.yml");
var asyncApiDocument = new AsyncApiStreamReader().Read(stream, out var diagnostic);
Reading External $ref

You can read externally referenced AsyncAPI documents by setting the ReferenceResolution property of the AsyncApiReaderSettings object to ReferenceResolutionSetting.ResolveAllReferences and providing an implementation for the IAsyncApiExternalReferenceReader interface. This interface contains a single method to which the built AsyncAPI.NET reader library will pass the location content contained in a $ref property (usually some form of path) and interface will return the content which is retrieved from wherever the $ref points to as a string. The AsyncAPI.NET reader will then automatically infer the T type of the content and recursively parse the external content into an AsyncAPI document as a child of the original document that contained the $ref. This means that you can have externally referenced documents that themselves contain external references.

This interface allows users to load the content of their external reference however and from whereever is required. A new instance of the implementor of IAsyncApiExternalReferenceReader should be registered with the ExternalReferenceReader property of the AsyncApiReaderSettings when creating the reader from which the GetExternalResource method will be called when resolving external references.

Below is a very simple example of implementation for IAsyncApiExternalReferenceReader that simply loads a file and returns it as a string found at the reference endpoint.

using System.IO;

public class AsyncApiExternalFileSystemReader : IAsyncApiExternalReferenceReader
{
    public string GetExternalResource(string reference)
    {
        return File.ReadAllText(reference);
    }
}

This can then be configured in the reader as follows:

var settings = new AsyncApiReaderSettings
{
  ReferenceResolution = ReferenceResolutionSetting.ResolveAllReferences,
  ExternalReferenceReader = new AsyncApiExternalFileSystemReader(),
};
var reader = new AsyncApiStringReader(settings);

This would function for a AsyncAPI document with following reference to load the content of message.yaml as a AsyncApiMessage object inline with the document object.

asyncapi: 2.3.0
info:
  title: test
  version: 1.0.0
channels:
  workspace:
    publish:
      message:
        $ref: "../../../message.yaml"

Bindings

To add support for reading bindings, simply add the bindings you wish to support, to the Bindings collection of AsyncApiReaderSettings. There is a nifty helper to add different types of bindings, or like in the example All of them.

var settings = new AsyncApiReaderSettings();
settings.Bindings = BindingsCollection.All;
var asyncApiDocument = new AsyncApiStringReader(settings).Read(stream, out var diagnostic);

Attribution

Contribution

This project welcomes contributions and suggestions. Do you want to contribute to the project? Find out how here.

License

Modified Apache 2.0 (Section 6)

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on AsyncAPI.NET:

Package Downloads
AsyncAPI.NET.Readers

AsyncAPI.NET Readers for JSON and YAML documents

AsyncAPI.NET.Bindings

AsyncAPI.NET Bindings

Benzene.Schema.OpenApi

Package Description

AsyncAPI.Net.UI

A .Net library to generate AsyncAPI documentation by code first, to easily share and maintain your event-driven architecture.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.0.0-beta.92 46 7/4/2024
6.0.0-beta.91 45 6/14/2024
5.2.2-beta.87 51 6/14/2024
5.2.1 964 6/12/2024
5.2.1-beta.86 43 5/28/2024
5.2.1-beta.85 41 5/28/2024
5.2.1-beta.84 783 5/21/2024
5.2.0 3,343 3/30/2024
5.2.0-beta.83 51 3/30/2024
5.2.0-beta.82 50 3/30/2024
5.2.0-beta.81 62 3/30/2024
5.2.0-beta.80 58 3/26/2024
5.2.0-beta.79 53 3/26/2024
5.2.0-beta.78 63 3/26/2024
5.2.0-beta.77 61 3/26/2024
5.2.0-beta.76 58 3/25/2024
5.2.0-beta.75 50 3/14/2024
5.2.0-beta.74 56 2/27/2024
5.2.0-beta.73 731 2/26/2024
5.2.0-beta.72 64 2/26/2024
5.2.0-beta.71 44 2/26/2024
5.1.1 1,473 2/16/2024
5.1.1-beta.69 51 2/16/2024
5.1.0 287 2/15/2024
5.1.0-beta 182 2/13/2024
5.0.0 2,861 12/14/2023
4.2.0-beta 1,162 11/1/2023
4.1.0 16,818 9/27/2023
4.1.0-beta 1,167 9/25/2023
4.0.2 12,883 8/1/2023
4.0.2-beta 588 7/30/2023
4.0.1 1,318 7/11/2023
4.0.1-beta 754 6/29/2023
4.0.0 2,612 6/12/2023
4.0.0-beta 1,009 6/5/2023
3.0.2 1,524 3/30/2023
3.0.1 2,869 3/13/2023
2.0.2 886 2/22/2023
2.0.1 2,196 2/8/2023
2.0.0 973 2/8/2023