/KnstEventBus

AsyncApi code-first tools for c#. Generate document and view.

Primary LanguageC#

Reference and Thanks

AsyncApi
tehmantra/saunter
domaindrivendev/Swashbuckle.AspNetCore
dotnet-architecture/eShopOnContainers
RicoSuter/Namotion.Reflection
JeringTech/Javascript.NodeJS


Requirements

  • Node.js v12.16+
  • npm v6.13.7+

Install

dotnet add package KnstAsyncApi --version 1.1.1
dotnet add package KnstAsyncApiUI --version 1.0.8

Register in Startup.cs ConfigureServices

services.AddAsyncApi(options =>
{
    options.AsyncApi = new AsyncApiDocument
    {
        Info = new Info("Async API", "1.0.0")
        {
            Description = "Description"
        }
    };
});
services.AddAsyncApiUI();

Use middleware

app.UseAsyncApi();
app.UseAsyncApiUI();

Add AsyncApi document mark

[AsyncApi]
[Channel]
[Message]
[Publish]
[Subscribe]

/// <summary>
/// HelloWorld Channel(Topic) Summary
/// </summary>
[AsyncApi]
[Channel("pubsub/HelloWorld")]
public class HelloWorldChannel : IPubChannel<HelloWorld>, ISubChannel
{
    /// <summary>
    /// HelloWorld Pub Summary
    /// </summary>
    [Publish]
    [Message(typeof(HelloWorld))]
    public Task PublishAsync(HelloWorld @event) => Task.CompletedTask;

    /// <summary>
    /// HelloWorld Sub Summary
    /// </summary>
    [Subscribe]
    [Message(typeof(HelloWorld))]
    public Task SubscribeAsync() => Task.CompletedTask;

    public Task UnSubscribeAsync() => Task.CompletedTask;
}

Visit your document

https://{domain-host}/asyncapi/asyncapi.json
https://localhost:5001/asyncapi/asyncapi.json
https://{domain-host}/asyncapi/index.html
https://localhost:5001/asyncapi/index.html

You can run my toys to get example.
toys-asyncapi-document

Licenses

The Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to https://unlicense.org