返回内容与IHttpActionResult非ok响应

对于从Web API 2控制器返回，如果响应是OK(状态200)，我可以返回内容与响应:

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

如果可能的话，我希望在这里尽可能使用内置结果类型

我的问题是，对于另一种类型的响应(不是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);
}

还是有更好的办法?

当前回答

这个答案是基于Shamil Yakupov的答案，用真实的对象而不是字符串。

using System.Dynamic;

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

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

2017-11-18 10:22:28

其他回答

你还可以:

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

2015-05-14 13:22:51

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

2015-03-03 09:20:55

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

return Ok()

return NotFound()

为Web Api控制器选择正确的返回类型

2018-06-01 17:50:54

一个更详细的示例，支持在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);

2019-08-07 18:37:55

这个答案是基于Shamil Yakupov的答案，用真实的对象而不是字符串。

using System.Dynamic;

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

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

2017-11-18 10:22:28

返回内容与IHttpActionResult非ok响应

推荐文章

最新文章

标签