BrighterCommand/Brighter

[Feature] Add Support for Generating AsyncAPI

Open

#3828 opened on Oct 3, 2025

View on GitHub
 (3 comments) (2 reactions) (1 assignee)HTML (1,898 stars) (295 forks)batch import
.NET0 - BacklogAgent FriendlyDocumentationV10.Xfeature requesthelp wanted

Description

Is your feature request related to a problem? Please describe. Similar to how OpenAPI support works in ASP.NET, it should be possible to generate an AsyncAPI document to represent the brokers, channels, messages, and operations used by the application.

Describe the solution you'd like Similar to the way AddSwaggerGen(), it should be possible to generate an AsyncAPI document in Brighter via AddAsyncAPIGen(). We would then document the endpoints exposed by the application.

It probably makes sense to use the AsyncAPI .NET https://github.com/asyncapi/net-sdk to produce the AsyncAPI document.

Since we don't automatically set up a website, we won't add one to display AsyncAPI documentation.

We should add protocol-specific bindings that allow configuration, provided we have the necessary information to complete them.

Describe alternatives you've considered We could go with a contract-first approach and generate the Brighter client from AsyncAPI. However, we will leave that to a separate story about scaffolding.

Contributor guide

Tech stack
csharp
Domain
apidocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C#.NETAspNetCore OpenAPI integration patternAsyncAPI basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine the existing OpenAPI integration in ASP.NET Core (AddSwaggerGen) to understand the pattern. Explore the Brighter codebase for any existing API documentation generation. Review the AsyncAPI .NET SDK on GitHub (asyncapi/net sdk) to understand how to produce the document. Check the issue comments for any additional requirements or ongoing discussions.