使用 IHttpActionResult 为非 OK 响应返回内容

Question

为了从 Web API 2 控制器返回，如果响应正常（状态 200），我可以返回包含响应的内容，如下所示：

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

如果可能，我想尽可能在​​这里使用内置结果类型：https://msdn.microsoft.com/en-us/library/system.web.http.results(v=vs.118).aspx

我的问题是，对于另一种类型的响应（不是 200），我怎样才能用它返回消息（字符串）？例如，我可以这样做：

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

但不是这个：

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

理想情况下，我希望将其通用化，以便我可以使用 IHttpActionResult 的任何实现发回消息。

我是否需要这样做（并构建我自己的响应消息）：

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

或者有更好的方法吗？

Answer 1

下面的代码/类对处理所有类型的响应非常有帮助。可能成功也可能失败等等。

我为什么要使用这个？ ：

假设我正在使用 Web API 服务。输出的几种可能性如下：

1. 由于验证错误，您可能不会得到任何结果
2. 你会得到预期的结果
3. 你会得到错误。

所以在这里我有处理所有场景的解决方案。我也试图保持输出的一致性。您可以给出备注或实际的错误信息。 Web服务消费者只能检查IsSuccess是否为真，否则确定有问题，并根据情况采取行动。 Web API 开发者和 Web API 消费者之间应该有完美的沟通。如果结果没有产生那么为什么。评论或例外将承认，他们将采取相应的行动。 因此，这是 Web API 消费者/用户的最佳解决方案。

所有类型结果的单一响应。

  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 Request.CreateResponse(HttpStatusCode.OK, _res);
            }
            catch (Exception ex)
            {
                _res.IsSuccess = false;
                _res.ErrorMessage = ex;
                return ResponseMessage(Request.CreateResponse(HttpStatusCode.InternalServerError, _res )); 
            } 
        }

如果有任何建议，欢迎您提出建议:)

如果有人使用并从中受益，我很高兴。如果有任何添加或修改使这更加改进，请在 akhandagale65@gmail.com 上写信给我。

Answer 2

简单：

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

记得参考 System.Net.Http 和 System.Net。

Answer 3

你可以用这个：

return BadRequest("No data is present in table!!");

Answer 4

支持未在 C# HttpStatusCode 中定义的 HTTP 代码的更详细示例。

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

Content 是定义在抽象类ApiController 中的虚方法，它是控制器的基础。声明如下：

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

Answer 5

我会推荐阅读这篇文章。有很多方法可以按照建议使用现有的 HttpResponse，但是如果您想利用 Web Api 2，那么请考虑使用一些内置的 IHttpActionResult 选项，例如

return Ok() 

或

return NotFound()

Choose the right return type for Web Api Controllers

Answer 6

对于例外情况，我通常会这样做

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

Answer 7

此答案基于 Shamil Yakupov 答案，使用真实对象而不是字符串。

using System.Dynamic;

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

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

Answer 8

我遇到了同样的问题。我想为我的 api 控制器创建自定义结果，像这样调用它们 return Ok("some text");

然后我这样做了： 1) 使用单音创建自定义结果类型

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) 使用新方法创建自定义控制器：

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

然后我可以在我的控制器中调用它们，如下所示：

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

Answer 9

在 ASP.NET Web API 2 中，您可以将任何 ResponseMessage 包装在 ResponseMessageResult 中：

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

在某些情况下，这可能是获得所需结果的最简单方法，尽管通常最好使用System.Web.Http.Results 中的各种结果。

Answer 10

抱歉回答晚了，你为什么不简单使用

return BadRequest("your message");

我将它用于我所有的 IHttpActionResult 错误，它运行良好

这里是文档：https://msdn.microsoft.com/en-us/library/system.web.http.apicontroller.badrequest(v=vs.118).aspx

Answer 11

任何有兴趣返回任何状态码并返回 ResponseMessage 的人：

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

Answer 12

你可以用这个：

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

Answer 13

你可以使用HttpRequestMessagesExtensions.CreateErrorResponse（System.Net.Http命名空间），像这样：

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

最好根据请求创建响应，以利用 Web API 的内容协商。

Answer 14

你也可以这样做：

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

Answer 15

@mayabelle 你可以创建具体的 IHttpActionResult 并像这样包装这些代码：

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

Answer 16

我最终选择了以下解决方案：

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

... 可以这样使用：

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

我愿意接受改进建议。 :)