从WebAPI 2端点返回自定义HTTP状态代码

Question

我正在使用WebAPI 2中的服务，并且端点当前返回IHttpActionResult 。 我想返回状态码422 ，但是由于它不在HttpStatusCode枚举中，所以我对如何发送该方法感到困惑，因为所有构造函数都需要HttpStatusCode的参数

就目前情况而言，我返回的是BadResult(message) ，但是返回422 +的消息对我的客户来说更具描述性和实用性。 有任何想法吗？

Answer 1

根据C＃规范：

枚举类型可以采用的值集不受其枚举成员的限制。 特别是，枚举的基础类型的任何值都可以转换为枚举类型，并且是该枚举类型的不同有效值

因此，您可以将状态代码422强制转换为HttpStatusCode。

控制器示例：

using System.Net;
using System.Net.Http;
using System.Web.Http;

namespace CompanyName.Controllers.Api
{
    [RoutePrefix("services/noop")]
    [AllowAnonymous]
    public class NoOpController : ApiController
    {
        [Route]
        [HttpGet]
        public IHttpActionResult GetNoop()
        {
            return new System.Web.Http.Results.ResponseMessageResult(
                Request.CreateErrorResponse(
                    (HttpStatusCode)422,
                    new HttpError("Something goes wrong")
                )
            );
        }
    }
}

Answer 2

 return Content((HttpStatusCode) 422, whatEver);

功劳是： 对于非OK响应，返回带有IHttpActionResult的内容

并且您的代码必须为<= 999

请忽略100到200之间的代码。

Answer 3

我用这种方式简单而优雅。

public ActionResult Validate(User user)
{
     return new HttpStatusCodeResult((HttpStatusCode)500, 
               "My custom internal server error.");
}

然后是角度控制器。

function errorCallBack(response) {            
$scope.response = {
   code: response.status,
   text: response.statusText
}});    

希望对您有帮助。

Answer 4

为此，您可能需要使用动作过滤器属性 。 没有什么花哨。 只需创建一个类并从c＃中的ActionFilterAttribute类继承即可。 然后重写一个名为OnActionExecuting的方法以实现此目的。 然后，只需在任何控制器的头上使用此过滤器即可。 以下是一个演示。

在需要在ActionFilterAttribute生成基于自定义状态代码的消息的情况下，可以通过以下方式编写：

        if (necessity_to_send_custom_code)
        {
            actionContext.Response = actionContext.Request.CreateResponse((HttpStatusCode)855, "This is custom error message for you");
        }

希望这可以帮助。

Answer 5

另一个简化的示例：

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

Content是在抽象类ApiController （控制器的基础）中定义的虚拟方法。 参见以下声明：

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

Answer 6

我在控制器中使用了一个自定义过滤器，该过滤器会捕获所有异常并返回自定义错误结果，因此我需要一种基于异常消息返回自定义消息响应的方法。

我正在使用JsonResult （位于Microsoft.AspNetCore.Mvc命名空间中）返回自定义状态代码和消息，例如：

public class DomainViolationFilter : ExceptionFilterAttribute
    {
        public override void OnException(ExceptionContext context)
        {
            switch (context.Exception)
            {
                case EntityNotFoundException e:
                    JsonResult toReturn = new JsonResult(e);
                    toReturn.StatusCode = 404;
                    context.Result = toReturn;
                    return;
            }
        }
    }

就我而言，为简单起见，我直接对异常对象（ex）进行了序列化，但是您应该只返回相关（和安全）的数据，或用例中需要的任何数据。