KnstAsyncApi 1.0.3-pre
This is a prerelease version of KnstAsyncApi.
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package KnstAsyncApi --version 1.0.3-pre
NuGet\Install-Package KnstAsyncApi -Version 1.0.3-pre
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<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 and Polyglot Notebooks. 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 & KnstAsyncApiUI
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.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Microsoft.AspNetCore.Http (>= 2.2.2)
- Microsoft.Extensions.Options (>= 3.1.5)
- Namotion.Reflection (>= 1.0.12)
- Newtonsoft.Json (>= 12.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.