I have an ASP.NET Core API (.Net Core 2.1) and I implemented an Action Filter using this article
https://docs.microsoft.com/en-us/aspnet/core/mvc/controllers/filters?view=aspnetcore-2.1#action-filters
In my Model, I use Data Annotations to validate the model, and I added the ValidateModel attribute for the Action in my Controller.
[HttpPost("CreateShipment")]
[ValidateModel]
public IActionResult CreateShipment([FromBody] CreateShipmentRequest request)
{
if (ModelState.IsValid)
{
//Do something
}
return Ok();
}
I used Postman to test this, and my Action Filter gets called only if the Model is valid. If my request is missing a required field or some value is out of range, Action Filter doesn't get called. Instead I receive a 400 bad request with the model state in the response.
I implemented the Action Filter because I want to customize my model validation error. My understanding is that Action Filters get called at the time of model binding. Can someone help me figure out why this is happening and how to get the Action Filter to work?
UPDATE: I found the solution 2 seconds after posting the question, and the link @Silvermind posted below is great info too.
I added the following line to my Startup.cs
services.Configure<ApiBehaviorOptions>(options =>
{
options.SuppressModelStateInvalidFilter = true;
});
It's well documented here on the Microsoft site. https://docs.microsoft.com/en-us/aspnet/core/web-api/index?view=aspnetcore-2.1#automatic-http-400-responses
Action filters – They run right before and after the action method execution. Exception filters – They are used to handle exceptions before the response body is populated. Result filters – They run before and after the execution of the action methods result.
Short answer: MVC and Web API filters are not cross compatible, and if you want to register them globally, you must use the appropriate configuration classes for each. Long answer: ASP.NET MVC and Web API are purposely designed to work in a similar way, but they are in fact different creatures.
Adding the following line to Startup.cs, ConfigureServices() method resolved the issue. turns out .Net Core has automatic 400 responses enabled by default. If you want to add custom Action Filters, you need to set those options at the startup.
services.Configure<ApiBehaviorOptions>(options =>
{
options.SuppressModelStateInvalidFilter = true;
});
It's well documented here on the Microsoft site:
https://docs.microsoft.com/en-us/aspnet/core/web-api/index?view=aspnetcore-2.1#automatic-http-400-responses
The [ApiController] attributes performs model validation automatically and triggers an HTTP response of 404, in .Net Core 3.0 you can chain to the new AddControllers() to suppress this feature:
services.AddControllers()
.ConfigureApiBehaviorOptions(options =>
{
options.SuppressModelStateInvalidFilter = true;
});
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With