BrighterCommand / BrighterCommand/Brighter

[Feature] Add Support for Generating AsyncAPI

Open
#3,828 3 comments 2 reactions 1 assignee Claimed by @PaulOberg1 View on GitHub
.NET 3 - Done Agent Friendly Documentation feature request help wanted V10.X
Dominant language
C#
Stars
2.5k
Forks
296
Avg merge
1d 11h
Merged PRs (30d)
21

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

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.