ByteBardOrg/ByteBard.AsyncAPI.NET.Bindingsv1.0.0
✓ Verified.NET 8.0.NET Std2.0.NET Std2.1
AsyncAPI.NET Bindings
Get Started
$ dotnet add package ByteBard.AsyncAPI.NET.BindingsReadme
AsyncAPI.NET
This serves as the official future of AsyncAPI.NET. To be able to give the level of support I want, I have had to fork my original work from the ByteBard Group, and create my own. This is unfortunate, but after much back and not a lot of forth, I have decided that it was time.
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: TODO
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",
Message = new List<AsyncApiMessage>
{
new AsyncApiMessageReference("#/components/messages/MyMessage"),
},
},
}
},
},
Components = new AsyncApiComponents
{
Messages = new Dictionary<string, AsyncApiMessage>
{
{
"MyMessage", new AsyncApiMessage
{
Name = "Hello!",
}
},
},
},
};
var yaml = myFirstAsyncApi.SerializeAsYaml(AsyncApi);
//asyncapi: 2.6.0
// info:
// title: my first asyncapi
//channels:
// users:
// subscribe:
// operationId: users
// description: my users channel
// message:
// $ref: '#/components/messages/MyMessage'
//components:
// messages:
// MyMessage:
// name: Hello!