Trả lại nội dung với IHttpActionResult cho phản hồi không OK

Để trả về từ bộ điều khiển API Web 2, tôi có thể trả về nội dung với phản hồi nếu phản hồi là OK (trạng thái 200) như thế này:

    public IHttpActionResult Get()
    {
        string myResult = ...
        return Ok(myResult);
    }

Nếu có thể, tôi muốn sử dụng các loại kết quả tích hợp tại đây khi có thể: https://msdn.microsoft.com/en-us/l Library / system.web.http.results (v = vs.118) .aspx

Câu hỏi của tôi là, đối với một loại phản hồi khác (không phải 200), làm thế nào tôi có thể trả lại một tin nhắn (chuỗi) với nó? Ví dụ: tôi có thể làm điều này:

    public IHttpActionResult Get()
    {
       return InternalServerError();
    }

nhưng không phải cái này:

    public IHttpActionResult Get()
    {
       return InternalServerError("Message describing the error here");
    }

Lý tưởng nhất là tôi muốn điều này được khái quát hóa để tôi có thể gửi lại tin nhắn với bất kỳ triển khai nào của IHttpActionResult.

Tôi có cần phải làm điều này không (và xây dựng thông điệp phản hồi của riêng tôi):

    public IHttpActionResult Get()
    {
       HttpResponseMessage responseMessage = ...
       return ResponseMessage(responseMessage);
    }

đây có phải là cách tốt hơn không?

Bạn có thể sử dụng điều này:

return Content(HttpStatusCode.BadRequest, "Any object");

Bạn có thể sử dụng HttpRequestMessagesExtensions.CreateErrorResponse ( System.Net.Httpkhông gian tên), như vậy:

public IHttpActionResult Get()
{
   return ResponseMessage(Request.CreateErrorResponse(HttpStatusCode.InternalServerError, "Message describing the error here"));
}

Tốt nhất là tạo phản hồi dựa trên yêu cầu để tận dụng lợi thế đàm phán nội dung của API Web.

Tôi đã kết thúc với giải pháp sau đây:

public class HttpActionResult : IHttpActionResult
{
    private readonly string _message;
    private readonly HttpStatusCode _statusCode;

    public HttpActionResult(HttpStatusCode statusCode, string message)
    {
        _statusCode = statusCode;
        _message = message;
    }

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        HttpResponseMessage response = new HttpResponseMessage(_statusCode)
        {
            Content = new StringContent(_message)
        };
        return Task.FromResult(response);
    }
}

... có thể được sử dụng như thế này:

public IHttpActionResult Get()
{
   return new HttpActionResult(HttpStatusCode.InternalServerError, "error message"); // can use any HTTP status code
}

Tôi đang mở để đề xuất cải tiến. :)

Bạn cũng có thể làm:

return InternalServerError(new Exception("SOME CUSTOM MESSAGE"));

Bất cứ ai quan tâm đến việc trả lại bất cứ điều gì với bất kỳ mã trạng thái nào khi trả về Phản hồi:

//CreateResponse(HttpStatusCode, T value)
return ResponseMessage(Request.CreateResponse(HttpStatusCode.XX, object));

Trong ASP.NET Web API 2, bạn có thể gói bất kỳ ResponseMessagetrong FeedbackMessageResult :

public IHttpActionResult Get()
{
   HttpResponseMessage responseMessage = ...
   return new ResponseMessageResult(responseMessage);
}

Trong một số trường hợp, đây có thể là cách đơn giản nhất để có được kết quả mong muốn, mặc dù nhìn chung có thể sử dụng các kết quả khác nhau trong System.Web.Http.Results .

Đơn giản:

return ResponseMessage(Request.CreateErrorResponse(HttpStatusCode.InternalServerError, "Your message"));

Hãy nhớ tham khảo System.Net.Http và System.Net .

Tôi khuyên bạn nên đọc bài viết này. Có rất nhiều cách để sử dụng HttpResponse hiện tại như được đề xuất, nhưng nếu bạn muốn tận dụng Web Api 2, thì hãy xem xét sử dụng một số tùy chọn IHttpActionResult tích hợp như

return Ok() 

hoặc là

return NotFound()

Chọn loại trả về đúng cho Bộ điều khiển Api Web

Một ví dụ chi tiết hơn với sự hỗ trợ của mã HTTP không được xác định trong C # HttpStatusCode.

public class MyController : ApiController
{
    public IHttpActionResult Get()
    {
        HttpStatusCode codeNotDefined = (HttpStatusCode)429;
        return Content(codeNotDefined, "message to be sent in response body");
    }
}

Contentlà một phương thức ảo được định nghĩa trong lớp trừu tượng ApiController, cơ sở của bộ điều khiển. Xem tờ khai như dưới đây:

protected internal virtual NegotiatedContentResult<T> Content<T>(HttpStatusCode statusCode, T value);

@mayabelle bạn có thể tạo bê tông IHttpActionResult và bọc các mã như thế này:

public class NotFoundPlainTextActionResult : IHttpActionResult
{
    public NotFoundPlainTextActionResult(HttpRequestMessage request, string message)
    {
        Request = request;
        Message = message;
    }

    public string Message { get; private set; }
    public HttpRequestMessage Request { get; private set; }

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        return Task.FromResult(ExecuteResult());
    }

    public HttpResponseMessage ExecuteResult()
    {
        var response = new HttpResponseMessage();

        if (!string.IsNullOrWhiteSpace(Message))
            //response.Content = new StringContent(Message);
            response = Request.CreateErrorResponse(HttpStatusCode.NotFound, new Exception(Message));

        response.RequestMessage = Request;
        return response;
    }
}

Tôi đã từng gặp vấn đề tương tự. Tôi muốn tạo kết quả tùy chỉnh cho bộ điều khiển api của mình, để gọi chúng như return Ok("some text");

Sau đó, tôi đã làm điều này: 1) Tạo loại kết quả tùy chỉnh với singletone

public sealed class EmptyResult : IHttpActionResult
{
    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        return Task.FromResult(new HttpResponseMessage(System.Net.HttpStatusCode.NoContent) { Content = new StringContent("Empty result") });
    }
}

2) Tạo bộ điều khiển tùy chỉnh với phương thức mới:

public class CustomApiController : ApiController
{
    public IHttpActionResult EmptyResult()
    {
        return new EmptyResult();
    }
}

Và sau đó tôi có thể gọi chúng trong bộ điều khiển của mình, như thế này:

public IHttpActionResult SomeMethod()
    {
       return EmptyResult();
    }

câu trả lời này dựa trên câu trả lời của Shamil Yakupov, với vật thật thay vì chuỗi.

using System.Dynamic;

dynamic response = new ExpandoObject();
response.message = "Email address already exist";

return Content<object>(HttpStatusCode.BadRequest, response);

Đối với trường hợp ngoại lệ, tôi thường làm

 catch (Exception ex)
        {
            return InternalServerError(new ApplicationException("Something went wrong in this request. internal exception: " + ex.Message));
        }

Trên đây là những điều thực sự hữu ích.

Trong khi tạo dịch vụ web, Nếu bạn có trường hợp dịch vụ, người tiêu dùng sẽ đánh giá rất cao. Tôi đã cố gắng duy trì tính đồng nhất của đầu ra. Ngoài ra, bạn có thể đưa ra nhận xét hoặc thông báo lỗi thực tế. Người tiêu dùng dịch vụ web chỉ có thể kiểm tra IsSuccess đúng hay không, chắc chắn sẽ có vấn đề và hoạt động theo tình huống.

  public class Response
    {
        /// <summary>
        /// Gets or sets a value indicating whether this instance is success.
        /// </summary>
        /// <value>
        /// <c>true</c> if this instance is success; otherwise, <c>false</c>.
        /// </value>
        public bool IsSuccess { get; set; } = false;

        /// <summary>
        /// Actual response if succeed 
        /// </summary>
        /// <value>
        /// Actual response if succeed 
        /// </value>
        public object Data { get; set; } = null;

        /// <summary>
        /// Remark if anythig to convey
        /// </summary>
        /// <value>
        /// Remark if anythig to convey
        /// </value>
        public string Remark { get; set; } = string.Empty;
        /// <summary>
        /// Gets or sets the error message.
        /// </summary>
        /// <value>
        /// The error message.
        /// </value>
        public object ErrorMessage { get; set; } = null;


    }  




[HttpGet]
        public IHttpActionResult Employees()
        {
            Response _res = new Response();
            try
            { 
                DalTest objDal = new DalTest(); 
                _res.Data = objDal.GetTestData();
                _res.IsSuccess = true;
                return Ok<Response>(_res);
            }
            catch (Exception ex)
            {
                _res.IsSuccess = false;
                _res.ErrorMessage = ex;
                return ResponseMessage(Request.CreateResponse(HttpStatusCode.InternalServerError, _res )); 
            } 
        }

Bạn được chào đón để đưa ra gợi ý nếu có :)

Xin lỗi vì câu trả lời muộn tại sao bạn không sử dụng đơn giản

return BadRequest("your message");

Tôi sử dụng nó cho tất cả các IHttpActionResultlỗi của tôi nó hoạt động tốt

đây là tài liệu: https://msdn.microsoft.com/en-us/l Library / system.web.http.apicontler.badrequest (v = vs.118) .aspx