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

Popular posts from this blog

DevToys–A swiss army knife for developers

As a developer there are a lot of small tasks you need to do as part of your coding, debugging and testing activities.  DevToys is an offline windows app that tries to help you with these tasks. Instead of using different websites you get a fully offline experience offering help for a large list of tasks. Many tools are available. Here is the current list: Converters JSON <> YAML Timestamp Number Base Cron Parser Encoders / Decoders HTML URL Base64 Text & Image GZip JWT Decoder Formatters JSON SQL XML Generators Hash (MD5, SHA1, SHA256, SHA512) UUID 1 and 4 Lorem Ipsum Checksum Text Escape / Unescape Inspector & Case Converter Regex Tester Text Comparer XML Validator Markdown Preview Graphic Color B

Help! I accidently enabled HSTS–on localhost

I ran into an issue after accidently enabling HSTS for a website on localhost. This was not an issue for the original website that was running in IIS and had a certificate configured. But when I tried to run an Angular app a little bit later on http://localhost:4200 the browser redirected me immediately to https://localhost . Whoops! That was not what I wanted in this case. To fix it, you need to go the network settings of your browser, there are available at: chrome://net-internals/#hsts edge://net-internals/#hsts brave://net-internals/#hsts Enter ‘localhost’ in the domain textbox under the Delete domain security policies section and hit Delete . That should do the trick…

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.