从Web Api控制器返回http状态代码

我试图返回一个状态代码304未修改的web api控制器中的GET方法。

我成功的唯一方法是这样的:

public class TryController : ApiController
{
    public User GetUser(int userId, DateTime lastModifiedAtClient)
    {
        var user = new DataEntities().Users.First(p => p.Id == userId);
        if (user.LastModified <= lastModifiedAtClient)
        {
             throw new HttpResponseException(HttpStatusCode.NotModified);
        }
        return user;
    }
}

这里的问题是，它不是一个异常，它只是没有修改，所以客户端缓存是OK的。我还希望返回类型是一个用户(所有的web api示例显示与GET)不返回HttpResponseMessage或类似的东西。

当前回答

public HttpResponseMessage Post(Article article)
{
    HttpResponseMessage response = Request.CreateResponse<Article>(HttpStatusCode.Created, article);

    string uriToTheCreatedItem = Url.Route(null, new { id = article.Id });
    response.Headers.Location = new Uri(Request.RequestUri, uriToTheCreatedItem);

    return response;
}

2015-07-08 21:32:56

其他回答

另一个选择:

return new NotModified();

public class NotModified : IHttpActionResult
{
    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        var response = new HttpResponseMessage(HttpStatusCode.NotModified);
        return Task.FromResult(response);
    }
}

2016-11-15 13:56:13

public HttpResponseMessage Post(Article article)
{
    HttpResponseMessage response = Request.CreateResponse<Article>(HttpStatusCode.Created, article);

    string uriToTheCreatedItem = Url.Route(null, new { id = article.Id });
    response.Headers.Location = new Uri(Request.RequestUri, uriToTheCreatedItem);

    return response;
}

2015-07-08 21:32:56

更改GetXxx API方法以返回HttpResponseMessage，然后返回完整响应的类型化版本和NotModified响应的非类型化版本。

    public HttpResponseMessage GetComputingDevice(string id)
    {
        ComputingDevice computingDevice =
            _db.Devices.OfType<ComputingDevice>()
                .SingleOrDefault(c => c.AssetId == id);

        if (computingDevice == null)
        {
            return this.Request.CreateResponse(HttpStatusCode.NotFound);
        }

        if (this.Request.ClientHasStaleData(computingDevice.ModifiedDate))
        {
            return this.Request.CreateResponse<ComputingDevice>(
                HttpStatusCode.OK, computingDevice);
        }
        else
        {
            return this.Request.CreateResponse(HttpStatusCode.NotModified);
        }
    }

* ClientHasStale数据是我的扩展检查ETag和IfModifiedSince头。

MVC框架仍然应该序列化并返回您的对象。

NOTE

我认为通用版本将在未来的Web API版本中被删除。

2012-07-04 11:31:51

如果你需要返回一个IHttpActionResult并且想要返回错误代码和消息，使用:

return ResponseMessage(Request.CreateErrorResponse(HttpStatusCode.NotModified, "Error message here"));

2016-07-29 05:55:11

如果您希望将操作签名保留为返回User，还可以执行以下操作:

public User GetUser(int userId, DateTime lastModifiedAtClient)

如果你想返回200以外的值，那么你在你的动作中抛出一个HttpResponseException，并传递你想要发送给客户端的HttpResponseMessage。

2012-06-15 20:41:04

从Web Api控制器返回http状态代码

推荐文章

最新文章

标签