Data Validation

Apply ValidationAttribute subclass attributes to validate request parameter values and response results.

Parameter Value Validation

public interface IUserApi
{    
    [HttpGet("api/users/{email}")]
    Task<User> GetAsync(        
        [EmailAddress, Required] // These validation attributes are used to validate this parameter before the request
        string email);
}

Request and Response Model Validation

All properties of the User model used in both requests and responses are validated.

public interface IUserApi
{
    [HttpPost("api/users")]
    Task<User> PostAsync([Required][JsonContent] User user);
}

public class User
{
    [Required]
    [StringLength(10, MinimumLength = 1)]
    public string Account { get; set; }

    [Required]
    [StringLength(10, MinimumLength = 1)]
    public string Password { get; set; }
}

Disabling Data Validation

Data validation is enabled by default. You can disable data validation in the interface's HttpApiOptions configuration.

public void ConfigureServices(IServiceCollection services)
{
    services.AddHttpApi<IUserApi>().ConfigureHttpApi(o =>
    {
        // Disable data validation, even if validation attributes are applied, validation will not occur.
        o.UseParameterPropertyValidate = false;
        o.UseReturnValuePropertyValidate = false;
    }); 
}