การส่งคืนรหัสสถานะ http จากตัวควบคุม Web Api

ฉันกำลังพยายามส่งคืนรหัสสถานะ 304 ที่ไม่ได้แก้ไขสำหรับวิธีการ GET ในตัวควบคุมเว็บ api

วิธีเดียวที่ฉันประสบความสำเร็จคือสิ่งนี้:

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

ปัญหาที่นี่คือมันไม่ใช่ข้อยกเว้นมันไม่ได้ถูกแก้ไขดังนั้นแคชของลูกค้าก็โอเค ฉันต้องการให้ประเภทการคืนเป็นผู้ใช้ด้วย (เนื่องจากเว็บ api ทุกตัวอย่างแสดงด้วย GET) ไม่ส่งคืน HttpResponseMessage หรืออะไรทำนองนี้

ผมไม่ทราบว่าคำตอบเพื่อให้ถามทีมงาน ASP.NET ที่นี่

ดังนั้นเคล็ดลับคือการเปลี่ยนลายเซ็นไปและการใช้งานHttpResponseMessageRequest.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);
}

คุณสามารถทำสิ่งต่อไปนี้หากคุณต้องการเก็บลายเซ็นการกระทำไว้เป็นผู้ใช้ที่กลับมา:

public User GetUser(int userId, DateTime lastModifiedAtClient) 

หากคุณต้องการส่งคืนสิ่งอื่นนอกจาก200นั้นคุณจะส่งการHttpResponseExceptionกระทำของคุณและส่งผ่านสิ่งที่HttpResponseMessageคุณต้องการส่งให้ลูกค้า

ใน MVC 5 สิ่งต่าง ๆ ง่ายขึ้น:

return new StatusCodeResult(HttpStatusCode.NotModified, this);

เปลี่ยนเมธอด 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 ควรเป็นอันดับและส่งคืนวัตถุของคุณ

บันทึก

ฉันคิดว่าเวอร์ชันทั่วไปกำลังถูกลบใน Web API เวอร์ชันต่อ ๆ ไป

ฉันเกลียดการชนบทความเก่า แต่นี่เป็นผลลัพธ์แรกของเรื่องนี้ในการค้นหาของ Google และฉันมีเวลากับปัญหานี้ (แม้จะได้รับการสนับสนุนจากพวกคุณ) ดังนั้นที่นี่ไม่มีอะไรไป ...

หวังว่าโซลูชันของฉันจะช่วยให้ผู้ที่สับสนเช่นกัน

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

และจากนั้นก็รับมรดกจาก BaseController

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

แล้วใช้มัน

[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 ส่งคืนรหัสสถานะ 304 นี่คือการใช้ ApiController

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

เป็นทางเลือกคุณสามารถส่งคืนวัตถุที่มีการตอบสนอง

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

สำหรับเว็บ ASP.NET Api 2 โพสต์นี้จาก MSIHttpActionResultแนะนำให้เปลี่ยนประเภทการกลับมาของวิธีการที่จะ จากนั้นคุณสามารถกลับมาที่สร้างขึ้นในIHttpActionResultการดำเนินงานเช่นOk, BadRequestฯลฯ ( ดูที่นี่ ) หรือกลับการดำเนินงานของคุณเอง

สำหรับรหัสของคุณมันสามารถทำได้เช่น:

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

ตัวเลือกอื่น:

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

หากคุณต้องการส่งคืน IHttpActionResult และต้องการส่งคืนรหัสข้อผิดพลาดพร้อมข้อความให้ใช้:

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

ฉันไม่ต้องการเปลี่ยนลายเซ็นของฉันเพื่อใช้ประเภท HttpCreateResponse ดังนั้นฉันจึงคิดวิธีแก้ปัญหาเพิ่มเติมเล็กน้อยเพื่อซ่อนมัน

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

จากนั้นคุณสามารถเพิ่มวิธีการใน ApiController ของคุณ (หรือดีกว่าตัวควบคุมฐานของคุณ) เช่นนี้:

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

จากนั้นคุณสามารถส่งคืนได้เหมือนวิธีการที่มีในตัว:

[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 โดยใช้ moden เพิ่มเติม IHttpActionResultแนะนำใน 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);
    }
}

ลองสิ่งนี้:

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