Skip to main content

API Design in ASP.NET Core Part III

This week I had the honor to give a training to some of the newly started young professionals in our organisation. The topic of the training was API design in ASP.NET Core. During this training we discussed multiple topics and a lot of interesting questions were raised. I'll try to tackle some of them with a blog post.

The question I try to tackle today is...

What does the [APIController] attribute do?

If you created your first Web API in ASP.NET Core (through dotnet new webapi -o MyFirstAPI), you ended up with a WeatherForecastController containing the following code:

On top of this controller class, you see above the Route attribute, the ApiController attribute. Adding this attribute on top of your controller has a bigger impact than you would think and enables the following behaviours:

  • Attribute routing requirement
  • Automatic HTTP 400 responses
  • Binding source parameter inference
  • Multipart/form-data request inference
  • Problem details for error status codes

Attribute routing requirement

The moment you start using the ApiController attribute, attribute routing becomes a requirement. This means that actions in this controller are no longer accessible via routes defined through UseEndpoints() or UseMVC().

Automatic HTTP 400 responses

Adding the ApiController attribute will automatically check the model state and return HTTP 400 responses when your model state has validation errors. This makes the ModelState.IsValid check obsolete in your action methods:

Behind the scenes, a ModelStateInvalidFilter is registered, which runs during OnActionExecuting event and executes the code above.

Binding source parameter inference

Normally depending on where the data is coming from (URL, headers, request body, …) you need to explicitly annotate the parameters of your action method with a binding attribute like [FromBody] or [FromQuery].

After adding the ApiController attribute, binding source parameters are inferred using the following rules:

Binding Attribute Inference Rule
[FromBody] Inferred for any complex type
[FromForm] Inferred for any parameters of type IFormFile or IFormFileCollection
[FromQuery] Inferred for all the other action parameters
[FromRoute] Inferred for any action parameter whose name matches a parameter in the route template
[FromHeader] No inferred rule

Multipart/form-data request inference

The [ApiController] attribute applies an inference rule for action parameters of type IFormFile and IFormFileCollection. The multipart/form-data request content type is inferred for these types.

Problem details for error status codes

Furthermore, ApiController introduces the ValidationProblem format for HTTP 400 responses. It is a machine-readable RFC 7807 compliant format:

More information: https://learn.microsoft.com/en-us/aspnet/core/web-api/?view=aspnetcore-6.0#apicontroller-attribute

Labels:

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         ...
Read more

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

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,...
Read more