Zwracanie kodu stanu HTTP z kontrolera Web Api

Próbuję zwrócić kod stanu 304 niezmodyfikowany dla metody GET w kontrolerze interfejsu API sieci Web.

Jedynym sposobem, w jaki mi się udało, było coś takiego:

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

Problem polega na tym, że nie jest to wyjątek, po prostu nie jest modyfikowany, więc pamięć podręczna klienta jest OK. Chcę również, aby typem zwracanym był użytkownik (jak pokazują wszystkie przykłady interfejsu WWW z GET), nie zwracał HttpResponseMessage ani czegoś takiego.

Nie znałem odpowiedzi, więc zapytałem tutaj zespół ASP.NET .

Zatem sztuczka polega na zmianie podpisu HttpResponseMessagei użyciu 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);
}

Możesz również wykonać następujące czynności, jeśli chcesz zachować podpis akcji jako powracający użytkownik:

public User GetUser(int userId, DateTime lastModifiedAtClient) 

Jeśli chcesz zwrócić coś innego niż 200wtedy, wrzucisz HttpResponseExceptionakcję i przekazujesz wiadomość, HttpResponseMessagektórą chcesz wysłać do klienta.

W MVC 5 stało się łatwiej:

return new StatusCodeResult(HttpStatusCode.NotModified, this);

Zmień metodę API GetXxx, aby zwracała HttpResponseMessage, a następnie zwróć wersję napisaną dla pełnej odpowiedzi i wersję nietypową dla odpowiedzi Niezmodyfikowanej.

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

* Dane ClientHasStale to moje rozszerzenie do sprawdzania nagłówków ETag i IfModifiedSince.

Struktura MVC powinna nadal serializować i zwracać obiekt.

UWAGA

Myślę, że wersja ogólna jest usuwana w niektórych przyszłych wersjach interfejsu API sieci Web.

Nienawidzę podrzucać starych artykułów, ale jest to pierwszy wynik tego w wyszukiwarce Google i świetnie się bawiłem z tym problemem (nawet przy wsparciu was). Więc tutaj nie ma nic ...

Mam nadzieję, że moje rozwiązanie pomoże tym, którzy również byli zdezorientowani.

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

a następnie po prostu odziedziczyć od BaseController

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

a następnie używając go

[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 core 2.2 zwraca kod statusu 304. To używa ApiController.

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

Opcjonalnie możesz zwrócić obiekt z odpowiedzią

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

W przypadku ASP.NET Web Api 2 ten post od MS sugeruje zmianę typu zwracanej metody na IHttpActionResult. Następnie można powrócić wbudowany w IHttpActionResultrealizacji podobnego Ok, BadRequestitp ( patrz tutaj ) lub zwrócić swoją realizację.

W przypadku kodu można to zrobić w następujący sposób:

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

Inna opcja:

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

Jeśli chcesz zwrócić IHttpActionResult i chcesz zwrócić kod błędu plus komunikat, użyj:

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

Nie lubię zmieniać podpisu, aby użyć typu HttpCreateResponse, więc wymyśliłem trochę rozszerzonego rozwiązania, aby to ukryć.

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

Następnie możesz dodać metodę do ApiController (lub lepiej kontrolera podstawowego) w następujący sposób:

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

Następnie możesz zwrócić go tak jak każdą z wbudowanych metod:

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

Aktualizacja odpowiedzi @Aliostads przy użyciu większej ilości modów IHttpActionResultwprowadzonych w Web API 2.

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

Spróbuj tego :

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