AsyncAPI.Net.UI 0.0.1-alpha

This is a prerelease version of AsyncAPI.Net.UI.

dotnet add package AsyncAPI.Net.UI --version 0.0.1-alpha

NuGet\Install-Package AsyncAPI.Net.UI -Version 0.0.1-alpha

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="AsyncAPI.Net.UI" Version="0.0.1-alpha" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add AsyncAPI.Net.UI --version 0.0.1-alpha

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: AsyncAPI.Net.UI, 0.0.1-alpha"

#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 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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

📰 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 of Startup.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 of Startup.cs, MapRazorPages

app.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	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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

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	50	3/13/2024