.NET Web API HttpResponseMessage模式?

时间:2013-11-19 22:37:41

标签: asp.net .net asp.net-web-api

所以我看到Web API 2控制器返回HttpResponse和实际对象。例如:

 public HttpResponseMessage Get(string id)
    {
        var app = apps.Single(c => c.Id == id);

        return new HttpResponseMessage(HttpStatusCode.OK)
        {
            Content = new ObjectContent<object>(app,
                Configuration.Formatters.JsonFormatter)
        };
    }

 public Application Get(string id)
    {
        return apps.Single(c => c.Id == id);
    }

我的问题是'正确'的方式? #2要短得多但是#1更好或#2自动做#1#?

1 个答案:

答案 0 :(得分:12)

请参阅thisthis SO问题。

两种情况下的回复都是相同的(HttpResponseMessage)。

HttpResponseMessage允许您使用HTTP协议(例如,通过Headers属性)并统一您的返回类型。

返回CLR类型可以更具可读性,但是您可以灵活地返回具有不同状态代码的不同类型,除非您使用dynamicobject,这会失去返回特定类型的目的。

就个人而言,我更喜欢使用IHttpActionResult(在v2中添加)并在控制器操作上为预期的返回类型指定ResponseTypeAttribute以提高可读性。

[HttpGet]
[ResponseType(typeof(Portfolio))]
public IHttpActionResult GetPortfolio([FromUri] long id)
{
    // get portfolio

    return Ok(portfolio);
}

您可以使用默认的IHttpActionResult实现轻松操作响应消息(以RESTful方式)(请参阅上面的OkResult)。避免自己构建HttpResponseMessage也可以保持代码清洁。 Here是关于IHttpActionResult的正式文章,here是关于HttpResponseMessage vs IHttpActionResult的有趣的SO对话。