ASP.NET Web APIでModelState検証を処理する

ASP.NET Web APIを使用してモデルの検証を実現するにはどうすればよいかと思っていました。私は私のようなモデルを持っています：

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アクションがあります。

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

if(ModelState.IsValid)エラーメッセージを追加して処理し、ユーザーに渡すにはどうすればよいですか？

問題を分離するために、モデルの検証にアクションフィルターを使用することをお勧めします。そのため、APIコントローラーで検証を行う方法をそれほど気にする必要はありません。

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

たぶんあなたが探していたものではないかもしれませんが、誰かが知っているのはおそらく素晴らしいです：

.net Web Api 2を使用している場合は、次のことを実行できます。

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

モデルのエラーに応じて、次の結果が得られます。

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

このように、例えば：

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

これは次のような応答を返します（JSONを想定していますが、XMLの基本原則は同じです）。

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."]

もちろん、フィールド名やフィールドIDなどを追加するなど、好きな方法でエラーオブジェクト/リストを作成できます。

新しいエンティティのPOSTのような「一方向」のAjax呼び出しであっても、要求が成功したかどうかを示す何かを呼び出し元に返す必要があります。ユーザーがAJAX POSTリクエストを介して自分自身に関する情報を追加するサイトを想像してみてください。入力しようとした情報が有効でない場合はどうなりますか？保存アクションが成功したかどうかはどうやってわかりますか？

これを行うための最良の方法は、古き良きHTTPステータスコードなど200 OKを使用することです。そうすることで、JavaScriptは正しいコールバック（エラー、成功など）を使用して失敗を適切に処理できます。

ActionFilterとjQueryを使用した、このメソッドのより高度なバージョンに関する素晴らしいチュートリアルは次のとおりです。http：//asp.net/web-api/videos/getting-started/custom-validation

System.ComponentModel.DataAnnotations名前空間の属性を使用して、検証ルールを設定できます。詳細については、モデルの検証-Mike Wassonを参照してください。

ビデオASP.NET Web API、パート5：カスタム検証も参照してください-Jon Galloway

その他の参考資料

1. WebAPIとWebFormsを使用してクライアント側を散策する
2. ASP.NET Web APIがHTTPメッセージをドメインモデルにバインドする方法、およびWeb APIでメディア形式を操作する方法。
3. Dominick Baier-ASP.NET Web APIの保護
4. AngularJS検証をASP.NET Web API検証にフックする
5. ASP.NET MVCでAngularJSを使用してModelStateエラーを表示する
6. クライアントにエラーを表示する方法は？AngularJS / WebApi ModelState
7. Web APIでの依存性注入検証

または、アプリのエラーの簡単なコレクションを探している場合..これが私の実装です：

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

エラーメッセージの応答は次のようになります。

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

startup.csファイルに以下のコードを追加します

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

ここでは、モデルの状態エラーを1つずつ確認することができます

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

私は実装の問題だった受け入れられた解決パターンの私はModelStateFilterいつも戻ってくるしfalse（その後400）のためのactionContext.ModelState.IsValid特定のモデルオブジェクトのために：

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

私はJSONしか受け入れないので、カスタムモデルバインダークラスを実装しました。

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

モデルの直後に登録する方法

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

ここに記載されているように、例外をスローすることもできます。http： //blogs.msdn.com/b/youssefm/archive/2012/06/28/error-handling-in-asp-net-webapi.aspx

この記事の内容を実行するには、System.Net.Httpを含めることを忘れないでください。