Skip to main content

ASP.NET Core - TryParse error when using Minimal APIs

Minimal APIs are the recommended approach for building fast HTTP APIs with ASP.NET Core. They allow you to build fully functioning REST endpoints with minimal code and configuration. You don't need a controller but can just declare your API using a fluent API approach:

This makes it very convenient to build your APIs. However you need to be aware that a lot of magic is going behind the scenes when using this approach. And this magic can bite you in the foot.

Exactly what happened to me while building an autonomous agent invoked through a web hook.

The code

In my application I created the following API endpoint using the minimal API approach:

The minimal API injects an AzureDevOpsWebhookParser that looks like this:

Nothing special…

The problem

The problem was when I called this endpoint, it failed with the following error message:

InvalidOperationException: TryParse method found on AzureDevOpsWebhookParser with incorrect format. Must be a static method with format...

To understand what is going wrong, you need to know how the model binding  conventions work in ASP.NET Core Minimal APIs. If a parameter type has a public static TryParse method with one of the following signatures, the parameter will be bound using TryParse.

As our object doesn't implement such a method, you would think that it wouldn't be a problem. However, starting from .NET 6, a breaking change was introduced that validated the signature of any TryParse method found and throws an InvalidOperationException if it doesn’t match.

The solution

I looked at multiple ways to fix the problem. In the end I landed on a simple solution and just renamed the method to TryParsePayLoad so that the model binding conventions don’t apply.

Remark: While researching a possible solution I discovered the [AsParameters] attribute as a way to group some parameters into one object. But more details in my blog post tomorrow.

More information

Tutorial: Create a Minimal API with ASP.NET Core | Microsoft Learn

APIs overview | Microsoft Learn

Breaking change: TryParse and BindAsync methods are validated | Microsoft Learn

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) ...

A complex system designed from scratch never works

A few years ago, I worked as an architect on a big mainframe rewrite. I still count it as one of my failures. Not because the technology was wrong, but because I couldn't convince the management team to simplify the approach. Years later, the organization is still struggling to get the new system up and running. I left the project at the time, because I couldn't put my name behind an approach that would take very long and cost a lot of money without a working system to show for it along the way. Gall’s Law That memory keeps coming back to me, because it's a textbook case of Gall's Law playing out in real life. Gall's Law , from John Gall's Systemantics , states it plainly: A complex system that works is invariably found to have evolved from a simple system that worked. A complex system designed from scratch never works, and it cannot be patched to make it work. You have to start over with a simple system that works. What does that mean in practice,...