API Reference Documentation

[YohanSciubukgian]

The Aspire.dev documentation revamp is cool and it helps for a quick onboarding of Aspire. It would be highly valuable to have a centralized API reference documentation.

Aspire’s core features and integration components expose APIs through extension methods and dependency injection, but details are currently distributed across tutorials and package readmes, GitHub discussions/issues/PRs and Aspire Fridays Youtube sessions. A dedicated reference would provide a clear view of available classes, methods, properties, and configuration options with underground logic to better understands trades-off during aspire setup in our solutions.

Examples for inspiration:

• .NET API Browser
• Dapr API Reference
• Playwright API Reference
• Spring Boot API Docs

In addition, it would be helpful to have versioned documentation that tracks changes in main as well as across major.minor releases. This would make it easier to follow Aspire’s rapid evolution and understand upcoming features (main branch or previews).

It may already be available somewhere in the GitHub repo or old MSDN docs, but I couldn’t track it down.

[davidfowl]

FWIW aspire is here https://learn.microsoft.com/en-us/dotnet/api/?view=dotnet-aspire-13.0

@IEvangelist