Required attribute for an integer value

Question

I have a viewmodel with an Id property

[Required]
public int Id { get; set; }

But I think this attribute is working only for string propert

Answer 1

Use the Range Attribute.

Set minimum to 1 and maximum to int.MaxValue

[Range(1, int.MaxValue, ErrorMessage = "Value for {0} must be between {1} and {2}.")]

Answer 2

If you are using a database, you should use the attributes [Key] and [DatabaseGenerated(DatabaseGenerated.Identity)] and Id shouldn't be NULLABLE.

Answer 3

This is similar to the answer from @Lee Smith, but enables 0 to be valid input, which might be useful in some scenarios.

What you can do is to init the int value to another value then 0, like this:

[Range(0, int.MaxValue)]
public int value{ get; set; } = -1;

It would even be possible to support all values except int.MinValue by doing it like this:

[Range(int.MinValue + 1, int.MaxValue)]
public int value{ get; set; } = int.MinValue;

Answer 4

Change the type to Nullable<int> (shortcut int?) to allow null values.

Answer 5

For .NET Core (and maybe earlier versions) you can also create a custom attribute to perform the range validation for ease of reuse:

public class Id : ValidationAttribute
{
    protected override ValidationResult IsValid(
        object value,
        ValidationContext validationContext)
    {
        return Convert.ToInt32(value) > 0 ?
            ValidationResult.Success :
            new ValidationResult($"{validationContext.DisplayName} must be an integer greater than 0.");
    }
}

Use the Id attribute like this in your model:

public class MessageForUpdate
{
    [Required, Id]
    public int UserId { get; set; }
    [Required]
    public string Text { get; set; }
    [Required, Id]
    public int ChannelId { get; set; }
}

When the Id is <= 0 this error message is returned:

UserId must be an integer greater than 0.

No need to verify that the value is less than int.MaxValue (although it is nice to display that in the message) because the API will return this error by default before it gets this far even if the value is int.MaxValue + 1:

The JSON value could not be converted to System.Int32