Skip to main content

Bending Aspire to your will - Custom icons, URLs and a command to export your OpenAPI spec

I spend a lot of time testing and debugging APIs, and so do my AI agents. Lately I notice that my agents lose time and tokens on it. They look for the right port, guess at endpoints, fight with a terminal, and try to get the database back into a known state. Every run starts with the same detective work.

So for this series of posts I picked one scenario and I’m sticking with it: the API-testing loop. The goal is to adapt Aspire so that I (and my agents) can debug and test easily and efficiently.

Note: this post is part of a series about the demos from my session “Bending Aspire to your will”.

The app is the aspire-shop sample: a frontend, a catalog service, a basket service, a catalog DB manager, PostgreSQL and Redis. The loop I run by hand looks like this:

  • Get the OpenAPI spec
  • Fire a test call at an endpoint
  • Reset the state for a repeatable run
  • Browse and try the API in one place

Out of the box, that means four tools and a handful of terminals. The goal is to do all of it from the Aspire graph.

We start with the first step. aspire run gives you a working dashboard with all resources, but the defaults stop quickly:

  • I can’t tell my resources apart at a glance.
  • The links in the summary are not the ones I want to click.
  • To get the OpenAPI spec, I open a browser or a REST client, look up the port, and type the URL. Again.

    Let’s try to fix this!

    Icons and URLs: one line each

    Both are just annotations on the resource. WithIconName takes any Fluent UI system icon name:

    builder.AddProject<Projects.AspireShop_Frontend>("frontend")
        .WithIconName("window")
        .WithExternalHttpEndpoints()
        .WithUrls(context =>
        {
            context.Urls.Clear();
            context.Urls.Add(new() { Url = "/", DisplayText = "Online Store", Endpoint = context.GetEndpoint("https") });
            context.Urls.Add(new() { Url = "/cart", DisplayText = "Shopping Basket", Endpoint = context.GetEndpoint("https") });
        });

    Instead of https://localhost:7123/, the dashboard now shows “Online Store” and “Shopping Basket”.

    Remark: Urls.Clear() removes all URLs, including the ones Aspire adds by default. Everything you want to keep has to be added back.

    The other resources get the same treatment with a one-liner: .WithIconName("database") on the catalog DB manager, "book" on the catalog service, "cart" on the basket service.

     


    Export the OpenAPI spec as a command

    Now the more interesting part. I download the OpenAPI document of the catalog service with curl all the time. So why not make that a button on the resource?

    WithProcessCommand wraps a local executable as a dashboard command:

    #pragma warning disable ASPIREPROCESSCOMMAND001
    catalogService.WithProcessCommand(
        commandName: "export-openapi",
        displayName: "Export catalog OpenAPI",
        processSpecFactory: context =>
        {
            var exportDirectory = Path.Combine(builder.AppHostDirectory, "artifacts", "openapi");
            Directory.CreateDirectory(exportDirectory);
            var timestamp = DateTimeOffset.UtcNow.ToString("yyyyMMdd-HHmmss-fffffff", CultureInfo.InvariantCulture);
            var outputPath = Path.Combine(exportDirectory, $"catalog-openapi-{timestamp}.json");
            context.Logger.LogInformation("Exporting catalog OpenAPI to {OutputPath}.", outputPath);
    
            return new ProcessCommandSpec("curl")
            {
                Arguments =
                [
                    "--fail",
                    "--silent",
                    "--show-error",
                    "--remove-on-error",
                    "--connect-timeout", "10",
                    "--max-time", "30",
                    "--output", outputPath,
                    "--write-out", "OpenAPI export destination: %{filename_effective}\nHTTP status: %{http_code}\n",
                    new Uri(new Uri(catalogEndpoint.Url), "/openapi/v1.json").AbsoluteUri,
                ],
            };
        },
        commandOptions: new ProcessCommandOptions
        {
            IconName = "ArrowDownload",
            IsHighlighted = true,
            UpdateState = context => context.ResourceSnapshot.HealthStatus is HealthStatus.Healthy
                ? ResourceCommandState.Enabled
                : ResourceCommandState.Disabled,
        });
    #pragma warning restore ASPIREPROCESSCOMMAND001


    A few things worth pointing out:

    • The process spec is a factory. The endpoint URL is resolved when you click the button, not when the AppHost builds the graph. At build time the port isn’t known yet.
    • IsHighlighted = true puts the command directly on the resource row instead of in the overflow menu.
    • UpdateState disables the button until the service is healthy, so you can’t export from a service that isn’t running.
    • --fail and --remove-on-error make sure you never end up with a JSON file that is actually an HTTP error page.

    Remark: WithProcessCommand is experimental, hence the ASPIREPROCESSCOMMAND001 pragma. The API can change or disappear. I tested this with Aspire 13.6.5 on .NET 10.

    Click the button and a timestamped catalog-openapi-*.json appears in artifacts/openapi next to your AppHost. The output of curl shows up in the resource logs.

    That’s it! A few lines in the AppHost, and a manual step I repeated every day is now one click.

    More information

    Popular posts from this blog

    Podman– Command execution failed with exit code 125

    After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME         ...

    Cache stampede: when our cache turned against us

    While investigating some performance issues, we ran into an ASP.NET Core API that cached a fairly expensive aggregation query for 60 seconds. Under normal load, that was fine: one request rebuilds the cache, everyone else reads from it. Under peak load, dozens of requests would arrive in that same expiry window, all see a cache miss, and all fire the same expensive query in parallel. The database didn't like that. That was the moment when our caching layer stopped helping and started hurting. A burst of requests comes in at the same time, all miss the cache, and all go hammer the database or the downstream API at once. That's a cache stampede . The cache was supposed to protect our backend, and for a few hundred milliseconds it did the opposite. Why this happens IMemoryCache.GetOrCreate (and its async sibling) looks like it protects you, but it doesn't add any locking on its own. Look at the naive version: public async Task<Report> GetReportAsync(string key) ...

    VS Code Planning mode

    After the introduction of Plan mode in Visual Studio , it now also found its way into VS Code. Planning mode, or as I like to call it 'Hannibal mode', extends GitHub Copilot's Agent Mode capabilities to handle larger, multi-step coding tasks with a structured approach. Instead of jumping straight into code generation, Planning mode creates a detailed execution plan. If you want more details, have a look at my previous post . Putting plan mode into action VS Code takes a different approach compared to Visual Studio when using plan mode. Instead of a configuration setting that you can activate but have limited control over, planning is available as a separate chat mode/agent: I like this approach better than how Visual Studio does it as you have explicit control when plan mode is activated. Instead of immediately diving into execution, the plan agent creates a plan and asks some follow up questions: You can further edit the plan by clicking on ‘Open in Editor’: ...