Web Api: Base controller validation

Question

When using ASP.NET Web Api 2 I always need to include the same code:

public IHttpActionResult SomeMethod1(Model1 model)
{
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }
    //...
}

public IHttpActionResult SomeMethod2(Model2 model)
{
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }
    //...
}

I would like to move validation to the base controller that will be executed on each request. But there are many methods to override and I don't know, which one should I use and how.

public class BaseController : ApiController
{
    public void override SomeMethod(...)
    {
        if (!ModelState.IsValid)
        {
            // ???
        }
    }
}

Is there any example for validation in a base class for ASP.NET Web Api?

Dmytro Rudenko · Accepted Answer · 2013-11-22 14:09:46Z

6

Example from asp.net

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

and add this attribute to your methods

[ValidateModel]
public HttpResponseMessage SomeMethod1(Model1 model)

answered Nov 22, 2013 at 14:09

Dmytro Rudenko

2,5242 gold badges15 silver badges22 bronze badges

You could also register the action filter to run for all actions without having to use attributes. Might require checking in OnActionExecuting which method was used (as GET and DELETE do not usually receive a model).
– Marjan Venema
Commented Nov 22, 2013 at 14:43

Add a comment |

Collectives™ on Stack Overflow

Web Api: Base controller validation

1 Answer 1

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Related