Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lego/asyncapi.net
The AsyncAPI.NET SDK contains a useful object model for AsyncAPI documents in .NET
https://github.com/lego/asyncapi.net
asyncapi dotnet openapi
Last synced: 1 day ago
JSON representation
The AsyncAPI.NET SDK contains a useful object model for AsyncAPI documents in .NET
- Host: GitHub
- URL: https://github.com/lego/asyncapi.net
- Owner: LEGO
- License: other
- Created: 2021-12-27T09:30:27.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T11:34:28.000Z (8 months ago)
- Last Synced: 2024-05-21T13:02:09.081Z (8 months ago)
- Topics: asyncapi, dotnet, openapi
- Language: C#
- Homepage:
- Size: 1.86 MB
- Stars: 303
- Watchers: 8
- Forks: 16
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# 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](https://github.com/LEGO/AsyncAPI.NET/blob/main/CHANGELOG.md)
[Wiki and getting started guide](https://github.com/LEGO/AsyncAPI.NET/wiki)
## Installation
Install the NuGet packages:
### AsyncAPI.NET
[](https://www.nuget.org/packages/AsyncAPI.NET/)
[](https://www.nuget.org/packages/AsyncAPI.NET/)
### AsyncAPI.Readers
[](https://www.nuget.org/packages/AsyncAPI.NET.Readers/)
[](https://www.nuget.org/packages/AsyncAPI.NET.Readers/)
### AsyncAPI.Bindings
[](https://www.nuget.org/packages/AsyncAPI.NET.Bindings/)
[](https://www.nuget.org/packages/AsyncAPI.NET.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()` or `new AsyncApiDocument().SerializeAsYaml()`
### Writing
```csharp
var myFirstAsyncApi = new AsyncApiDocument
{
Info = new AsyncApiInfo
{
Title = "my first asyncapi"
},
Channels = new Dictionary
{
{
"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
```csharp
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.
```csharp
var settings = new AsyncApiReaderSettings();
settings.Bindings = BindingsCollection.All;
var asyncApiDocument = new AsyncApiStringReader(settings).Read(stream, out var diagnostic);
```
## Attribution
* [OpenAPI.Net](https://github.com/microsoft/OpenAPI.NET) - [MIT License](https://github.com/microsoft/OpenAPI.NET/blob/vnext/LICENSE)
* [YamlDotNet](https://github.com/aaubry/YamlDotNet) - [MIT License](https://github.com/aaubry/YamlDotNet/blob/master/LICENSE.txt)
## Contribution
This project welcomes contributions and suggestions.
Do you want to contribute to the project? Find out how [here](CONTRIBUTING.md).
## License
[Modified Apache 2.0 (Section 6)](https://github.com/LEGO/AsyncAPI.NET/blob/main/LICENSE)