ASP.NET Web API'de ModelState Doğrulamasını İşleyin

ASP.NET Web API ile nasıl model doğrulayabileceğimi merak ediyordum. Benim modelim şöyle:

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

Daha sonra API Denetleyicimde bir Gönder eylemim var:

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

if(ModelState.IsValid)Kullanıcıya iletilecek hata mesajını nasıl eklerim ve sonra işleyebilirim?

Kaygıyı ayırmak için, model doğrulama için eylem filtresi kullanmanızı öneririm, bu nedenle api denetleyicinizde doğrulama işlemini nasıl yapacağınızla ilgilenmenize gerek kalmaz:

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

Belki aradığınız şey değil, ama belki birinin bilmesi güzel:

.Net Web Api 2 kullanıyorsanız, aşağıdakileri yapabilirsiniz:

if (!ModelState.IsValid)
     return BadRequest(ModelState);

Model hatalarına bağlı olarak şu sonucu alırsınız:

{
   Message: "The request is invalid."
   ModelState: {
       model.PropertyA: [
            "The PropertyA field is required."
       ],
       model.PropertyB: [
             "The PropertyB field is required."
       ]
   }
}

Bunun gibi, örneğin:

public HttpResponseMessage Post(Person person)
{
    if (ModelState.IsValid)
    {
        PersonDB.Add(person);
        return Request.CreateResponse(HttpStatusCode.Created, person);
    }
    else
    {
        // the code below should probably be refactored into a GetModelErrors
        // method on your BaseApiController or something like that

        var errors = new List<string>();
        foreach (var state in ModelState)
        {
            foreach (var error in state.Value.Errors)
            {
                errors.Add(error.ErrorMessage);
            }
        }
        return Request.CreateResponse(HttpStatusCode.Forbidden, errors);
    }
}

Bu, şöyle bir yanıt döndürür (JSON varsayılır, ancak XML için aynı temel ilke):

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
(some headers removed here)

["A value is required.","The field First is required.","Some custom errorm essage."]

Elbette, hata nesnenizi / listenizi istediğiniz gibi oluşturabilirsiniz, örneğin alan adları, alan kimlikleri vb. Eklemek.

Yeni bir varlığın POST'u gibi "tek yönlü" bir Ajax çağrısı olsa bile, arayana yine de bir şey göndermelisiniz - isteğin başarılı olup olmadığını gösteren bir şey. Kullanıcınızın bir AJAX POST isteği aracılığıyla kendileri hakkında bazı bilgiler ekleyeceği bir site hayal edin. Ya girmeye çalıştıkları bilgiler geçerli değilse - Kaydet eylemlerinin başarılı olup olmadığını nasıl anlayacaklar?

Bunu yapmanın en iyi yolu kullanıyor Good Old HTTP Durum Kodları gibi 200 OKvb. Bu şekilde, JavaScript'iniz doğru geri aramaları (hata, başarı vb.) Kullanarak hataları düzgün bir şekilde halledebilir.

ActionFilter ve jQuery kullanarak, bu yöntemin daha gelişmiş bir sürümüyle ilgili güzel bir öğretici: http://asp.net/web-api/videos/getting-started/custom-validation

System.ComponentModel.DataAnnotationsDoğrulama kurallarını belirlemek için ad alanındaki öznitelikleri kullanabilirsiniz . Ayrıntılar için Model Doğrulama - Mike Wasson'a bakın.

Ayrıca ASP.NET Web API, Bölüm 5: Özel Doğrulama - Jon Galloway videosuna da bakın

Diğer referanslar

1. WebAPI ve WebForms ile İstemci Tarafında Bir Yürüyüşe Çıkın
2. ASP.NET Web API, HTTP mesajlarını etki alanı modellerine nasıl bağlar ve Web API'de medya biçimleriyle nasıl çalışılır.
3. Dominick Baier - ASP.NET Web API'lerinin Güvenliğini Sağlama
4. AngularJS doğrulamasını ASP.NET Web API Doğrulamasına bağlama
5. ASP.NET MVC'de AngularJS ile ModelState Hatalarını Görüntüleme
6. Hatalar müşteriye nasıl aktarılır? AngularJS / WebApi ModelState
7. Web API'de Bağımlılık Tarafından Eklenen Doğrulama

Veya uygulamalarınız için basit bir hata derlemesi arıyorsanız, işte benim uygulamam:

public override void OnActionExecuting(HttpActionContext actionContext)
    {
        var modelState = actionContext.ModelState;

        if (!modelState.IsValid) 
        {

            var errors = new List<string>();
            foreach (var state in modelState)
            {
                foreach (var error in state.Value.Errors)
                {
                    errors.Add(error.ErrorMessage);
                }
            }

            var response = new { errors = errors };

            actionContext.Response = actionContext.Request
                .CreateResponse(HttpStatusCode.BadRequest, response, JsonMediaTypeFormatter.DefaultMediaType);
        }
    }

Hata Mesajı Yanıtı şöyle görünecektir:

{
  "errors": [
    "Please enter a valid phone number (7+ more digits)",
    "Please enter a valid e-mail address"
  ]
}

Startup.cs dosyasına aşağıdaki kodu ekleyin

services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2).ConfigureApiBehaviorOptions(options =>
            {
                options.InvalidModelStateResponseFactory = (context) =>
                {
                    var errors = context.ModelState.Values.SelectMany(x => x.Errors.Select(p => new ErrorModel()
                   {
                       ErrorCode = ((int)HttpStatusCode.BadRequest).ToString(CultureInfo.CurrentCulture),
                        ErrorMessage = p.ErrorMessage,
                        ServerErrorMessage = string.Empty
                    })).ToList();
                    var result = new BaseResponse
                    {
                        Error = errors,
                        ResponseCode = (int)HttpStatusCode.BadRequest,
                        ResponseMessage = ResponseMessageConstants.VALIDATIONFAIL,

                    };
                    return new BadRequestObjectResult(result);
                };
           });

Burada model durumu hatasını tek tek göstermeyi kontrol edebilirsiniz.

 public HttpResponseMessage CertificateUpload(employeeModel emp)
    {
        if (!ModelState.IsValid)
        {
            string errordetails = "";
            var errors = new List<string>();
            foreach (var state in ModelState)
            {
                foreach (var error in state.Value.Errors)
                {
                    string p = error.ErrorMessage;
                    errordetails = errordetails + error.ErrorMessage;

                }
            }
            Dictionary<string, object> dict = new Dictionary<string, object>();



            dict.Add("error", errordetails);
            return Request.CreateResponse(HttpStatusCode.BadRequest, dict);


        }
        else
        {
      //do something
        }
        }

}

C #

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

...

    [ValidateModel]
    public HttpResponseMessage Post([FromBody]AnyModel model)
    {

Javascript

$.ajax({
        type: "POST",
        url: "/api/xxxxx",
        async: 'false',
        contentType: "application/json; charset=utf-8",
        data: JSON.stringify(data),
        error: function (xhr, status, err) {
            if (xhr.status == 400) {
                DisplayModelStateErrors(xhr.responseJSON.ModelState);
            }
        },
....


function DisplayModelStateErrors(modelState) {
    var message = "";
    var propStrings = Object.keys(modelState);

    $.each(propStrings, function (i, propString) {
        var propErrors = modelState[propString];
        $.each(propErrors, function (j, propError) {
            message += propError;
        });
        message += "\n";
    });

    alert(message);
};

Ben uygulayan bir sorunu vardı kabul çözüm desen benim ModelStateFilterhep döneceğini false(ve daha sonra 400) için actionContext.ModelState.IsValidbelirli bir model nesneler için:

public class ModelStateFilter : ActionFilterAttribute
{
    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        if (!actionContext.ModelState.IsValid)
        {
            actionContext.Response = new HttpResponseMessage { StatusCode = HttpStatusCode.BadRequest};
        }
    }
}

Yalnızca JSON'u kabul ediyorum, bu nedenle özel bir model bağlayıcı sınıfı uyguladım:

public class AddressModelBinder : System.Web.Http.ModelBinding.IModelBinder
{
    public bool BindModel(HttpActionContext actionContext, System.Web.Http.ModelBinding.ModelBindingContext bindingContext)
    {
        var posted = actionContext.Request.Content.ReadAsStringAsync().Result;
        AddressDTO address = JsonConvert.DeserializeObject<AddressDTO>(posted);
        if (address != null)
        {
            // moar val here
            bindingContext.Model = address;
            return true;
        }
        return false;
    }
}

Modelimden sonra doğrudan kaydettirdiğim

config.BindParameter(typeof(AddressDTO), new AddressModelBinder());

Ayrıca burada belgelendiği gibi istisnaları da atabilirsiniz: http://blogs.msdn.com/b/youssefm/archive/2012/06/28/error-handling-in-asp-net-webapi.aspx

Not, bu makalenin önerdiği şeyi yapmak için System.Net.Http'yi eklemeyi unutmayın.