An OpenAPI implementation for Aspire Dashboard

[Mermaid Isla (MermaidIsla)]

Hello, I found myself bored one day and decided to see if I can implement a UI for OpenAPI specifications which you would get from your API services.

This is actually the third prototype of this feature, last two can be found here and here. It's only after I posted those two that I found out there is a show and tell discussion category. Whoopsie...

Anyway, this feature allows you to send HTTP requests directly from the Aspire Dashboard and view any relevant trace details. Compared to the last two prototypes I made, this one is by far my best attempt at not only making it look nice but also useful.

For now OpenAPI documents are only being gathered through an HTTP request sent to a resource that maps the default OpenAPI endpoint with the default document name (aka. /openapi/v1.json).

The code for this feature can be found here.

I've also made a video which you can watch here.

I would also appreciate any/all help you may offer as I'm currently still very new to the Aspire repo. (I also am not a CSS person so please excuse any CSS imperfections.)

In case for some reason you cannot watch the video right now, here is also a picture of the new feature:

[Dan Moseley (danmoseley)]

interesting -- cc Safia Abdalla (@captainsafia) Mike Kistler (@mikekistler)

[Dan Moseley (danmoseley)]

James Newton-King (@JamesNK)

[Marcin Sulecki (sulmar)]

Great idea, but please use scalar instead of something new.

[Mermaid Isla (MermaidIsla)]

I believe the team here will take into consideration issue #3608 if they ever decide to implement OpenAPI standard.

If you don't want to read the whole conversation, in a nutshell, as of me writing this, the current proposal is that you, the developer, will have a choice whether you want to use the dashboard's OpenAPI UI or use something else like Scalar or Swagger. You would not be forced to use the dashboard as far as I understand it.

The dashboard's OpenAPI UI is therefore another option that you would be able choose from.

[Miguel Hasse de Oliveira (miguelhasse)]

Mermaid Isla (@MermaidIsla) the dashboard's OpenAPI UI is what makes sense for various reasons, like UI consistency, control, performance, and better integration.

By the way, good work!