c# - ASP.NETWebAPIでModelState検証を処理する

Question

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

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)エラーメッセージを追加して処理し、ユーザーに渡すにはどうすればよいですか？

Answer 1

関心の分離のために、モデルの検証にアクションフィルターを使用することをお勧めします。そのため、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);
        }
    }
}

Answer 2

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

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

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

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

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

Answer 3

このように、例えば：

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呼び出しであっても、呼び出し元に何かを返す必要があります。これは、要求が成功したかどうかを示すものです。ユーザーがAJAXPOSTリクエストを介して自分自身に関する情報を追加するサイトを想像してみてください。入力しようとした情報が有効でない場合はどうなりますか？保存アクションが成功したかどうかをどのようにして知ることができますか？

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

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

Answer 4

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

ビデオASP.NETWebAPI、パート5：カスタム検証-JonGallowayも参照してください。

その他の参考文献

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

Answer 5

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

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

Answer 6

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

Answer 7

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

Answer 8

ここでは、モデルの状態エラーを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
        }
        }

}

Answer 9

特定のモデルオブジェクトに対して常に戻る（その後は400）という、受け入れられたソリューションパターンの実装に問題がありました。ModelStateFilterfalseactionContext.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());

Answer 10

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

その記事が示唆していることを行うには、System.Net.Httpを含めることを忘れないでください。

Answer 11

これをstartup.csファイルに入れます

 services.AddMvc().ConfigureApiBehaviorOptions(options =>
        {
            options.InvalidModelStateResponseFactory = (context) =>
            {
                var errors = context.ModelState.Values.SelectMany(x => x.Errors.Select(p =>p.ErrorMessage)).ToList();                    
                var result = new Response
                {
                    Succeeded = false,
                    ResponseMessage = string.Join(", ",errors)
                };
                return new BadRequestObjectResult(result);
            };
        });