WebApi Controller returned value in Entity Framework 5 and MVC 4 project

Question

I'm working on a webapi, EF5, Windsor Castle in a MVC 4 project, and I have a question...should I return the Entity (or DTO) in the Get method or Should I return an HttpResponseMessage? What's the better way and more standard way to do it?

So, Is it this?

[System.Web.Http.HttpGet]
public HttpResponseMessage GetById(long id)
{
    var branch = Uow.Branches.GetById(id);
    if (branch != null)
    {
        Request.CreateResponse(HttpStatusCode.OK, branch);
    }

    throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.NotFound));
}

Or this?

[System.Web.Http.HttpGet]
public Branch GetById(long id)
{
    var branch = Uow.Branches.GetById(id);
    if (branch != null) return branch ;
    throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.NotFound));
}

aamir sajjad · Accepted Answer · 2012-11-04 13:46:32Z

3

I will return DTO wrapped in HttpResponseMessage as below:

return this.Request.CreateResponse(HttpStatusCode.OK, branch);

DTO/ViewModel will enable to send only required properties.

HttpResponseMessage allow to send additional status code, for example in case of invalid input, we can send statusCode precondition failed.

if (model.EventDate == null)
            {
                var responseMessage = new HttpResponseMessage();
                responseMessage.StatusCode = HttpStatusCode.PreconditionFailed;
                responseMessage.ReasonPhrase = "Please enter valid EventDate input";
                return responseMessage;

            }

answered Nov 4, 2012 at 13:46

aamir sajjad

3,0391 gold badge29 silver badges28 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Maggie Ying · Accepted Answer · 2012-11-03 17:20:56Z

1

Depends. However, in your example, since the two versions of the Get action produce the same reponse, I would return the entity Branch instead of the HttpResponseMessage. That is because the framework will help abstract out the actual creation of the HttpResponseMessage so the action focuses more on the business logic.

If you need more control over the reponse message (i.e. setting a different state code), than I would return the HttpResponseMessage instead.

Hope this helps.

answered Nov 3, 2012 at 17:20

Maggie Ying

10.2k2 gold badges37 silver badges37 bronze badges

Collectives™ on Stack Overflow

WebApi Controller returned value in Entity Framework 5 and MVC 4 project

2 Answers 2

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related