Web Api denetleyicisinden http durum kodu döndürme

Bir web api denetleyicisinde GET yöntemi için değiştirilmemiş 304 durum kodu döndürmeye çalışıyorum.

Başarabilmemin tek yolu şuydu:

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;
    }
}

Buradaki sorun bunun bir istisna olmaması, sadece istemci önbelleğinin iyi olması için değiştirilmedi. Ayrıca dönüş türü bir kullanıcı (tüm web api örnekleri GET ile gösterildiği gibi) HttpResponseMessage veya bunun gibi bir şey döndürmek istiyorum.

Cevabın böylece ASP.NET ekibi istedi bilmiyordum burada .

Yani hile imzayı değiştirmek HttpResponseMessageve kullanmaktır Request.CreateResponse.

[ResponseType(typeof(User))]
public HttpResponseMessage GetUser(HttpRequestMessage request, int userId, DateTime lastModifiedAtClient)
{
    var user = new DataEntities().Users.First(p => p.Id == userId);
    if (user.LastModified <= lastModifiedAtClient)
    {
         return new HttpResponseMessage(HttpStatusCode.NotModified);
    }
    return request.CreateResponse(HttpStatusCode.OK, user);
}

Eylem imzasını geri dönen Kullanıcı olarak korumak istiyorsanız aşağıdakileri de yapabilirsiniz:

public User GetUser(int userId, DateTime lastModifiedAtClient) 

Başka bir şey döndürmek istiyorsanız , eyleminize 200bir atar ve müşteriye göndermek istediğinizi HttpResponseExceptioniletirsiniz HttpResponseMessage.

MVC 5'te işler kolaylaştı:

return new StatusCodeResult(HttpStatusCode.NotModified, this);

HttpResponseMessage döndürmek için GetXxx API yöntemini değiştirin ve sonra tam yanıt için yazılan bir sürümü ve NotModified yanıt için türlenmemiş sürümü döndürün.

    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 verileri, ETag ve IfModifiedSince başlıklarını kontrol etmek için kullandığım uzantı.

MVC çerçevesi hala serileştirilmeli ve nesneniz döndürülmelidir.

NOT

Ben genel sürümü Web API gelecekteki bazı sürümünde kaldırılıyor düşünüyorum.

Eski makaleleri çarpmaktan nefret ediyorum, ancak bu google aramada bunun ilk sonucudur ve bu sorunla ilgili bir zamanım vardı (hatta sizlerin desteği ile). İşte burada hiçbir şey yok ...

Umarım benim çözümüm de karışık olanlara yardımcı olacaktır.

namespace MyApplication.WebAPI.Controllers
{
    public class BaseController : ApiController
    {
        public T SendResponse<T>(T response, HttpStatusCode statusCode = HttpStatusCode.OK)
        {
            if (statusCode != HttpStatusCode.OK)
            {
                // leave it up to microsoft to make this way more complicated than it needs to be
                // seriously i used to be able to just set the status and leave it at that but nooo... now 
                // i need to throw an exception 
                var badResponse =
                    new HttpResponseMessage(statusCode)
                    {
                        Content =  new StringContent(JsonConvert.SerializeObject(response), Encoding.UTF8, "application/json")
                    };

                throw new HttpResponseException(badResponse);
            }
            return response;
        }
    }
}

ve sonra sadece BaseController'dan miras alın

[RoutePrefix("api/devicemanagement")]
public class DeviceManagementController : BaseController
{...

ve sonra onu

[HttpGet]
[Route("device/search/{property}/{value}")]
public SearchForDeviceResponse SearchForDevice(string property, string value)
{
    //todo: limit search property here?
    var response = new SearchForDeviceResponse();

    var results = _deviceManagementBusiness.SearchForDevices(property, value);

    response.Success = true;
    response.Data = results;

    var statusCode = results == null || !results.Any() ? HttpStatusCode.NoContent : HttpStatusCode.OK;

    return SendResponse(response, statusCode);
}

.net çekirdek 2.2 304 durum kodu döndürüyor. Bu bir ApiController kullanıyor.

    [HttpGet]
    public ActionResult<YOUROBJECT> Get()
    {
        return StatusCode(304);
    }

İsteğe bağlı olarak bir nesneyi yanıtla döndürebilirsiniz

    [HttpGet]
    public ActionResult<YOUROBJECT> Get()
    {
        return StatusCode(304, YOUROBJECT); 
    }

ASP.NET Web Api 2 için, MS'nin bu yayını , yöntemin dönüş türünü değiştirmenizi önerir IHttpActionResult. Daha sonra bir yerleşik dönebilirsiniz IHttpActionResultgibi uygulanması Ok, BadRequestvb ( burada bakınız ) veya kendi uygulamasını dönün.

Kodunuz için şu şekilde yapılabilir:

public IHttpActionResult GetUser(int userId, DateTime lastModifiedAtClient)
{
    var user = new DataEntities().Users.First(p => p.Id == userId);
    if (user.LastModified <= lastModifiedAtClient)
    {
        return StatusCode(HttpStatusCode.NotModified);
    }
    return Ok(user);
}

Başka seçenek:

return new NotModified();

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

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;
}

Bir IHttpActionResult döndürmeniz gerekiyorsa ve hata kodunu ve bir iletiyi döndürmek istiyorsanız, şunu kullanın:

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

HttpCreateResponse türünü kullanmak için imzamı değiştirmek zorunda kalmayı sevmiyorum, bu yüzden bunu gizlemek için biraz genişletilmiş bir çözüm buldum.

public class HttpActionResult : IHttpActionResult
{
    public HttpActionResult(HttpRequestMessage request) : this(request, HttpStatusCode.OK)
    {
    }

    public HttpActionResult(HttpRequestMessage request, HttpStatusCode code) : this(request, code, null)
    {
    }

    public HttpActionResult(HttpRequestMessage request, HttpStatusCode code, object result)
    {
        Request = request;
        Code = code;
        Result = result;
    }

    public HttpRequestMessage Request { get; }
    public HttpStatusCode Code { get; }
    public object Result { get; }

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        return Task.FromResult(Request.CreateResponse(Code, Result));
    }
}

Daha sonra ApiController'ınıza (veya temel kontrol cihazınızı daha iyi) aşağıdaki gibi bir yöntem ekleyebilirsiniz:

protected IHttpActionResult CustomResult(HttpStatusCode code, object data) 
{
    // Request here is the property on the controller.
    return new HttpActionResult(Request, code, data);
}

Ardından, yerleşik yöntemlerden herhangi biri gibi iade edebilirsiniz:

[HttpPost]
public IHttpActionResult Post(Model model)
{
    return model.Id == 1 ?
                Ok() :
                CustomResult(HttpStatusCode.NotAcceptable, new { 
                    data = model, 
                    error = "The ID needs to be 1." 
                });
}

@Aliostads için bir güncelleme IHttpActionResult, Web API 2'de sunulan daha fazla moden kullanarak cevap verir .

https://docs.microsoft.com/en-us/aspnet/web-api/overview/getting-started-with-aspnet-web-api/action-results#ihttpactionresult

public class TryController : ApiController
{
    public IHttpActionResult GetUser(int userId, DateTime lastModifiedAtClient)
    {
        var user = new DataEntities().Users.First(p => p.Id == userId);
        if (user.LastModified <= lastModifiedAtClient)
        {
            return StatusCode(HttpStatusCode.NotModified);
            // If you would like to return a Http Status code with any object instead:
            // return Content(HttpStatusCode.InternalServerError, "My Message");
        }
        return Ok(user);
    }
}

Bunu dene :

return new ContentResult() { 
    StatusCode = 404, 
    Content = "Not found" 
};