WebApi .net core 3.1 - How to customize validation message for null posting?

user_4489400 0
Viewed 46

I have a class which is a parameter of a method in controller which has a required property (mark as [Required]).

When I pass a null value to that property I get a message saying:

 "errors": {
    "testNumber": [
        "Error converting value {null} to type 'System.Int32'. Path 'testNumber', line 21, position 15."
    ]
}

Similarly, when I pass a null value to that property I get a message saying:

"errors": {
    "testNumber": [
        "JSON integer 999999999999999999999999999 is too large or small for an Int32. Path 'testNumber', line 21, position 38."
    ]
}

I want to customize the friendly messages saying:

"errors": {
    "testNumber": [
        "null is not a valid value for TestNumber."
]

or

"errors": {
    "testNumber": [
        "999999999999999999999999999 is not a valid value for TestNumber."
    ]
}

My TestClass is very simple:

public class TestClass
{
     [Required]
     public int TestNumber{ get; set; }
}

I have a look at some posts they suggest to use:

[Required(ErrorMessage="<your value> is not a valid value for TestNumber.")]
public int TestNumber{ get; set; }

But by doing this way, I can't get the original value sent from client. So is this possible to customize the messages like above?

Thank you.

webapi .net-core-3.1 validation c#
1 Answers

So it's a bit messy but you can use CustomAttributes for this. You're basically rewriting logic, but not the end of the world: https://docs.microsoft.com/en-us/aspnet/core/mvc/models/validation?view=aspnetcore-6.0#custom-attributes

This will be able to perform what you want to do. If you don't like the sound of that, you'll probably want to look at writing middleware or filters in .NET Core:

https://docs.microsoft.com/en-us/aspnet/core/mvc/controllers/filters?view=aspnetcore-6.0

https://docs.microsoft.com/en-us/aspnet/core/fundamentals/middleware/?view=aspnetcore-6.0

Someone more learned than me may be able to tell you how to put this together in a nice way (as I don't know), but you'd essentially be replacing the inbuilt .NET Core validation logic with your own.

user_98225280
Related