AsyncAPI.NET.Bindings
5.2.3
See the version list below for details.
dotnet add package AsyncAPI.NET.Bindings --version 5.2.3
NuGet\Install-Package AsyncAPI.NET.Bindings -Version 5.2.3
<PackageReference Include="AsyncAPI.NET.Bindings" Version="5.2.3" />
paket add AsyncAPI.NET.Bindings --version 5.2.3
#r "nuget: AsyncAPI.NET.Bindings, 5.2.3"
// Install AsyncAPI.NET.Bindings as a Cake Addin #addin nuget:?package=AsyncAPI.NET.Bindings&version=5.2.3 // Install AsyncAPI.NET.Bindings as a Cake Tool #tool nuget:?package=AsyncAPI.NET.Bindings&version=5.2.3
AsyncAPI.NET
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
AsyncAPI.Readers
AsyncAPI.Bindings
Example Usage
Main classes to know:
- AsyncApiStringReader
- AsyncApiStringWriter
- There is an extension on the AsyncApiDocument type which allows Serializing as well (
new AsyncApiDocument().SerializeAsJson()
ornew AsyncApiDocument().SerializeAsYaml()
- There is an extension on the AsyncApiDocument type which allows Serializing as well (
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);
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
Product | Versions 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. |
-
.NETStandard 2.0
- AsyncAPI.NET (>= 5.2.3)
- AsyncAPI.NET.Readers (>= 5.2.3)
-
net6.0
- AsyncAPI.NET (>= 5.2.3)
- AsyncAPI.NET.Readers (>= 5.2.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on AsyncAPI.NET.Bindings:
Repository | Stars |
---|---|
asyncapi/saunter
Saunter is a code-first AsyncAPI documentation generator for dotnet.
|
Version | Downloads | Last updated | |
---|---|---|---|
6.0.0-beta.96 | 51 | 8/22/2024 | |
6.0.0-beta.95 | 49 | 8/16/2024 | |
6.0.0-beta.94 | 35 | 8/12/2024 | |
6.0.0-beta.93 | 36 | 8/8/2024 | |
6.0.0-beta.92 | 66 | 7/4/2024 | |
6.0.0-beta.91 | 41 | 6/14/2024 | |
5.2.4 | 1,423 | 7/29/2024 | |
5.2.3 | 44 | 7/29/2024 | |
5.2.2 | 47 | 7/29/2024 | |
5.2.2-beta.87 | 47 | 6/14/2024 | |
5.2.1 | 206 | 6/12/2024 | |
5.2.1-beta.86 | 42 | 5/28/2024 | |
5.2.1-beta.85 | 39 | 5/28/2024 | |
5.2.1-beta.84 | 900 | 5/21/2024 | |
5.2.0 | 1,047 | 3/30/2024 | |
5.2.0-beta.83 | 46 | 3/30/2024 | |
5.2.0-beta.82 | 45 | 3/30/2024 | |
5.2.0-beta.81 | 54 | 3/30/2024 | |
5.2.0-beta.80 | 52 | 3/26/2024 | |
5.2.0-beta.79 | 52 | 3/26/2024 | |
5.2.0-beta.78 | 58 | 3/26/2024 | |
5.2.0-beta.77 | 53 | 3/26/2024 | |
5.2.0-beta.76 | 51 | 3/25/2024 | |
5.2.0-beta.75 | 48 | 3/14/2024 | |
5.2.0-beta.74 | 52 | 2/27/2024 | |
5.2.0-beta.73 | 860 | 2/26/2024 | |
5.2.0-beta.72 | 50 | 2/26/2024 | |
5.2.0-beta.71 | 58 | 2/26/2024 | |
5.1.1 | 656 | 2/16/2024 | |
5.1.1-beta.69 | 61 | 2/16/2024 | |
5.1.0 | 136 | 2/15/2024 | |
5.1.0-beta | 88 | 2/13/2024 | |
5.0.0 | 737 | 12/14/2023 | |
4.2.0-beta | 852 | 11/1/2023 | |
4.1.0 | 11,938 | 9/27/2023 | |
4.1.0-beta | 791 | 9/25/2023 | |
4.0.2 | 11,365 | 8/1/2023 | |
4.0.2-beta | 119 | 7/30/2023 | |
4.0.1 | 367 | 7/11/2023 | |
4.0.1-beta | 273 | 6/29/2023 | |
4.0.0 | 757 | 6/12/2023 | |
4.0.0-beta | 536 | 6/5/2023 |