在 ASP.NET Web API 中处理 ModelState 验证 [英] Handle ModelState Validation in ASP.NET Web API

问题描述

我想知道如何使用 ASP.NET Web API 实现模型验证.我的模型是这样的:

I was wondering how I can achieve model validation with ASP.NET Web API. I have my model like so:

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; }
}

然后我在我的 API 控制器中有一个 Post 操作:

I then have a Post action in my API Controller:

public void Post(Enquiry enquiry)
{
    enquiry.EnquiryDate = DateTime.Now;
    context.DaybookEnquiries.Add(enquiry);
    context.SaveChanges();
}

如何添加if(ModelState.IsValid)，然后处理错误信息传递给用户?

How do I add if(ModelState.IsValid) and then handle the error message to pass down to the user?

推荐答案

对于关注点分离，我建议您使用 action filter 进行模型验证，这样您就不必太关心如何在您的 api 控制器中进行验证:

For separation of concern, I would suggest you use action filter for model validation, so you don't need to care much how to do validation in your api controller:

using System.Net;
using System.Net.Http;
using System.Web.Http.Controllers;
using System.Web.Http.Filters;

namespace System.Web.Http.Filters
{
    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);
        }
    }
}

这篇关于在 ASP.NET Web API 中处理 ModelState 验证的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！