AsyncAPI.Net.UI
0.0.1-alpha
dotnet add package AsyncAPI.Net.UI --version 0.0.1-alpha
NuGet\Install-Package AsyncAPI.Net.UI -Version 0.0.1-alpha
<PackageReference Include="AsyncAPI.Net.UI" Version="0.0.1-alpha" />
paket add AsyncAPI.Net.UI --version 0.0.1-alpha
#r "nuget: AsyncAPI.Net.UI, 0.0.1-alpha"
// Install AsyncAPI.Net.UI as a Cake Addin
#addin nuget:?package=AsyncAPI.Net.UI&version=0.0.1-alpha&prerelease
// Install AsyncAPI.Net.UI as a Cake Tool
#tool nuget:?package=AsyncAPI.Net.UI&version=0.0.1-alpha&prerelease
๐ฐ AsyncAPI.Net.UI
A .Net library to generate AsyncAPI 2.0 documentation by code first, to easily share and maintain your event-driven architecture.
๐งช Test It :
Download the repo
Run AsyncAPI.NET.UI.Sample
GO http://localhost:5000/asyncapi
And see : ๐ง add screenshoots
๐ Getting Started :
Install the standard Nuget package into your ASP.NET Core application.
๐ง CLI : dotnet add package --version ?.?.? AsyncAPI.Net.UI
Add import
using AsyncApi.Net.Ui.Extensions; using AsyncApi.Net.Ui.Models;
In the
ConfigureServices(IServiceCollection services)
method ofStartup.cs
, register the AsyncApiDoc generator, defining one or more AsyncApiDoc documents.services.AddMvc(); services.AddAsyncApiDocumentation(new AsyncApiDocInfo() { Title = "My title AsyncAPI", Description = "The great description of the my AcyncApi", ContactName = "Crazy Coder", ContactUrl = "https://www.microsoft.com/" });
In the
Configure(IApplicationBuilder app, IApiVersionDescriptionProvider provider)
method ofStartup.cs
, MapRazorPagesapp.UseRouting(); app.UseEndpoints(endpoints => { endpoints.MapControllers(); endpoints.MapRazorPages(); });
๐ Links :
- AsyncApi : https://www.asyncapi.com/en
- AsyncApi Studio : https://www.asyncapi.com/en
- AsyncAPI.NET : https://github.com/LEGO/AsyncAPI.NET
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. 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. |
-
net7.0
- AsyncAPI.NET (>= 4.1.0)
- Microsoft.AspNetCore.Cors (>= 2.2.0)
- Microsoft.AspNetCore.Mvc.Cors (>= 2.2.0)
- Newtonsoft.Json (>= 13.0.3)
- Newtonsoft.Json.Schema (>= 3.0.15)
- System.ComponentModel.Annotations (>= 5.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
0.0.1-alpha | 55 | 3/13/2024 |