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 channelReading
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.Add(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.