KnstAsyncApi 1.0.3-pre

AsyncApi code-first document generator

This is a prerelease version of KnstAsyncApi.
There is a newer version of this package available.
See the version list below for details.
Install-Package KnstAsyncApi -Version 1.0.3-pre
dotnet add package KnstAsyncApi --version 1.0.3-pre
<PackageReference Include="KnstAsyncApi" Version="1.0.3-pre" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add KnstAsyncApi --version 1.0.3-pre
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: KnstAsyncApi, 1.0.3-pre"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install KnstAsyncApi as a Cake Addin
#addin nuget:?package=KnstAsyncApi&version=1.0.3-pre&prerelease

// Install KnstAsyncApi as a Cake Tool
#tool nuget:?package=KnstAsyncApi&version=1.0.3-pre&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Reference and Thanks

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


KnstAsyncApi Nuget & KnstAsyncApiUI Nuget

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

Add "Target Tag" into your .csproj file

<Target Name="NpmInstall" AfterTargets="Build;Publish;" Condition="!Exists('bin\$(Configuration)\$(TargetFramework)\node_modules')">
    <Exec WorkingDirectory="bin\$(Configuration)\$(TargetFramework)\" Command="npm install" ContinueOnError="true">
        <Output TaskParameter="ExitCode" PropertyName="ErrorCode" />
    </Exec>
    <Error Condition="'$(ErrorCode)' != '0'" Text="Node.js/npm is required to build this project. To continue, please install Node.js from https://nodejs.org/ or Visual Studio Installer, and then restart your command prompt or IDE." />
</Target>

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")]
[Message(typeof(HelloWorld))]
public class HelloWorldChannel : IChannel<HelloWorld>
{
    /// <summary>
    /// HelloWorld Pub Summary
    /// </summary>
    [Publish]
    public Task PublishAsync(HelloWorld @event) => Task.CompletedTask;

    /// <summary>
    /// HelloWorld Sub Summary
    /// </summary>
    [Subscribe]
    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

Reference and Thanks

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


KnstAsyncApi Nuget & KnstAsyncApiUI Nuget

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

Add "Target Tag" into your .csproj file

<Target Name="NpmInstall" AfterTargets="Build;Publish;" Condition="!Exists('bin\$(Configuration)\$(TargetFramework)\node_modules')">
    <Exec WorkingDirectory="bin\$(Configuration)\$(TargetFramework)\" Command="npm install" ContinueOnError="true">
        <Output TaskParameter="ExitCode" PropertyName="ErrorCode" />
    </Exec>
    <Error Condition="'$(ErrorCode)' != '0'" Text="Node.js/npm is required to build this project. To continue, please install Node.js from https://nodejs.org/ or Visual Studio Installer, and then restart your command prompt or IDE." />
</Target>

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")]
[Message(typeof(HelloWorld))]
public class HelloWorldChannel : IChannel<HelloWorld>
{
    /// <summary>
    /// HelloWorld Pub Summary
    /// </summary>
    [Publish]
    public Task PublishAsync(HelloWorld @event) => Task.CompletedTask;

    /// <summary>
    /// HelloWorld Sub Summary
    /// </summary>
    [Subscribe]
    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

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.1.1 209 1/23/2021
1.1.0 119 12/2/2020
1.0.3-pre 279 6/17/2020