Manejar validación de modelo de estado en ASP.NET Web API

Question

Me preguntaba cómo puedo lograr la validación de modelo con API web de ASP.NET. Tengo mi modelo de este modo:

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

que luego tienen una acción Publicar en mi controlador de API:

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

¿Cómo agrego if(ModelState.IsValid) y luego manejar el mensaje de error para transmitir a los usuarios?

Answer 1

Para la separación de preocupación, sugeriría que utilice filtro de acción para la validación del modelo, por lo que no es necesario importa mucho cómo hacer la validación en su controlador 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

Así, por ejemplo:

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

Esto devolverá una respuesta como esta (suponiendo JSON, pero el mismo principio básico para 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."] 

Por supuesto, puede construir su error Objeto/lista de la manera que desee, por ejemplo, agregar nombres de campo, identificador de campo, etc.

Incluso si se trata de una llamada Ajax "de una sola vía" como una POST de una nueva entidad, aún debe devolver algo a la persona que llama, algo que indica si la solicitud fue exitosa o no. Imagine un sitio donde su usuario agregará información acerca de sí mismo a través de una solicitud AJAX POST. ¿Qué ocurre si la información que intentaron ingresar no es válida? ¿Cómo sabrán si su acción de Guardar fue exitosa o no?

La mejor manera de hacerlo es usando Buenos códigos de estado de HTTP como 200 OK y así sucesivamente. De esta forma, su JavaScript puede manejar fallas de forma adecuada utilizando las devoluciones de llamada correctas (error, éxito, etc.).

Aquí hay un buen tutorial en una versión más avanzada de este método, utilizando un ActionFilter y jQuery: http://asp.net/web-api/videos/getting-started/custom-validation

Answer 3

tal vez no lo que estaba buscando, pero tal vez agradable para alguien que sabe:

Si está usando API .NET web 2 se podía solo haz lo siguiente g:

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

En función de los errores en el modelo, se obtiene el siguiente resultado:

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

Answer 4

También puede lanzar excepciones como se documenta aquí: http://blogs.msdn.com/b/youssefm/archive/2012/06/28/error-handling-in-asp-net-webapi.aspx

Nota, para hacer lo que sugiere que el artículo , recuerde incluir System.Net.Http

Answer 5

Puede usar atributos del espacio de nombres System.ComponentModel.DataAnnotations para establecer las reglas de validación. Consulte Model Validation - By Mike Wasson para obtener más detalles.

refieren también vídeo ASP.NET Web API, Part 5: Custom Validation - Jon Galloway

Otras Referencias

1. Take a Walk on the Client Side with WebAPI and WebForms
2. How ASP.NET Web API binds HTTP messages to domain models, and how to work with media formats in Web API.
3. Dominick Baier - Securing ASP.NET Web APIs
4. Hooking AngularJS validation to ASP.NET Web API Validation
5. Displaying ModelState Errors with AngularJS in ASP.NET MVC
6. How to render errors to client? AngularJS/WebApi ModelState
7. Dependency-Injected Validation in Web API

Answer 6

tuve un problema la aplicación de la accepted solution pattern donde mi ModelStateFilter que siempre devuelven false (y, posteriormente, una 400) para actionContext.ModelState.IsValid para ciertos objetos del modelo:

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

Solo acepto JSON, así que implementé una clase de cuaderno de modelo personalizado:

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

Qué puedo registrar directamente después de mi modelo a través de

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

Answer 7

Aquí puede comprobar para mostrar el error de estado del modelo uno a uno

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 8

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 9

O, si usted está buscando sencilla colección de errores para sus aplicaciones .. aquí está mi aplicación de esta:

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

Mensaje de error La respuesta será como la siguiente:

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