如何在 ASP.NET Web API 中有效实现模型验证？

ASP.NET Web API 中的模型验证

模型验证是开发强大的 Web API 的一个重要方面。 ASP.NET Web API 提供了一个用于验证传入模型数据的综合系统。

实现模型验证

要实现模型验证，请按照以下步骤操作：

1. 启用模型验证：启用自动Web API 配置中的验证：

   config.Filters.Add(new ValidateModelFilter());

2. 注释您的模型： 使用数据注释指定模型属性的验证规则。例如：

   public class Enquiry
   {
       [Key]
       public int EnquiryId { get; set; }
       [Required]
       public DateTime EnquiryDate { get; set; }
       [Required]
       public string CustomerAccountNumber { get; set; }
       [Required]
       public string ContactName { get; set; }
   }

3. 使用自定义操作过滤器： 创建自定义操作过滤器来处理模型验证错误。全局或在控制器级别注册此过滤器：

   public class ValidationActionFilter : ActionFilterAttribute
   {
       public override void OnActionExecuting(HttpActionContext actionContext)
       {
           var modelState = actionContext.ModelState;
   
           if (!modelState.IsValid)
               actionContext.Response = actionContext.Request
                    .CreateErrorResponse(HttpStatusCode.BadRequest, modelState);
       }
   }

处理验证失败

当模型验证失败时：

• HttpActionContext 的 ModelState 属性将包含验证列表错误。
• 自定义操作过滤器可以访问此属性并创建适当的错误响应。

其他注意事项

• 您可以通过 ModelState 的 Errors 属性访问验证错误。
• 自定义返回到的错误消息客户端。
• 确保模型验证在整个 API 中保持一致。

以上是如何在 ASP.NET Web API 中有效实现模型验证？的详细内容。更多信息请关注PHP中文网其他相关文章！