CODEWITHSUNDEEP
asp.netasp.net-mvcasp.net-web-apiasp.net-web-api2model-binding
thinkmmk
thinkmmk

Reputation: 487

MediaFormatter or ModelBinder for web api PUT method

I have a PUT method in web api which accepts a JSON data and a route data as follows.

[Route("api/v1/Orders/{orderId}/active")]
    public HttpResponseMessage Put(Guid? orderId,List<ActiveRequest> activeRequests)
    {


    }
public class ActiveRequest
{
    public int Id { get; set; }
    public bool IsActive { get; set; } 
}

Now is it possible to simplify the method signature as:

[Route("api/v1/Orders/{orderId}/active")]
    public HttpResponseMessage Put(ActiveRequestModel model)
    {


    }
public class ActiveRequestModel
{
    public Guid OrderId { get; set; }
    public List<ActiveRequest> ActiveRequests {get; set;} 
}

I tried writing a custom ModelBinder by implementing the System.Web.Http.ModelBinding.IModelBinder interface but could'nt find a way to read the JSON data that is coming inside the Request object. I doubt that is there a way by which I can bind my model with data coming from three different places i.e. from route data, json & form.

Upvotes: 0

Views: 442

Answers (1)

JotaBe
JotaBe

Reputation: 39045

You cannot simplify the parameter as described.

Unlike MVC model binding, beacuse of how the Web API formatter works, in Web API you only can have a single parameter that is deserialized from the payload, and a number of simple type parameters coming from route parameters or url query string. The reason is that the creation of the parameter coming from the payload is done in a single pass deserialization of the payload.

So, for your example you need the two parameters in your original version, i.e.:

public HttpResponseMessage Put(Guid? orderId, List<ActiveRequest> activeRequests)

If you want to use the ActiveRequestModel you need to include a payload which has exactly the same structure, so you should include the orderId in the payload, because it will not be recovered from the url (even if the name matches).

Please, read this article which explains how parameter binding works in Web API:

If you read it thoroughly you'll see that you can create and register your own model binder to make it work the same way that an MVC controller, but I think it's not worth the effort (so I include it only in this last paragraph), and it's not the standard way of working.

Upvotes: 1

Related Questions