Web API2，如何返回错误

Question

public IHttpActionResult Save(item)
{
    try
    {
        result = MyRepository.Save(item);
        return Ok(result);
    }
    catch
    {
        // What should I do here?
        // I wish to return an error response how can i do that? 
    }
}

如果没有异常，我可以返回 Ok。

但如果出现异常，我该怎么办？

请注意，我有 javascript 客户端

Answer 1

创建一个模型来保存您想要返回并传递的错误信息。

public IHttpActionResult Save(item) {
    try {
        result = MyRepository.Save(item);
        return Ok(result);
    } catch {
        // What should I do here? Create a model to hold the data you want to return
        var myErrorModel = new {
            code = "My custom error code or 500 server error code",
            message = "some friendly error message"
        };

        // I wish to return an error response how can i do that?
        var response = Request.CreateResponse(HttpStatusCode.InternalServerError, myErrorModel);
        return ResponseMessage(response);
    }
}

在错误处理程序中的 javascript 客户端中，您可以访问模型属性并按照您认为合适的方式处理错误。

var handleResponse = function (data) {
    var code = data.code;
    var message = data.message
};

更新：

同意@Win，我个人不喜欢在控制器操作中这样做，因为它是一个横切关注点，并且基本上已将所有内容从 catch 块内移到全局错误处理程序中。

Answer 2

在 Web API 2 中，您可以使用BadRequest返回错误消息。

public IHttpActionResult Save(item)
{
    try
    {
        result = MyRepository.Save(item);
        return Ok(result);
    }
    catch
    {
        return BadRequest("Error message");
    }
}

仅供参考：不要使用try catch 块来吞下异常。 我个人不喜欢在 Action 方法中使用try catch块。 相反，我让 Web API 2 Global Exception Handler 处理异常。 这超出了您原始问题的范围。

Answer 3

您可以使用 HttpResponseException 发送错误消息。

public IHttpActionResult Save(item)
{
    try
    {
        result = MyRepository.Save(item);
        return Ok(result);
    }
    catch
    {
       var resp = new HttpResponseMessage(HttpStatusCode.NotFound)
        {
            Content = new StringContent(string.Format("Error Message!!"),
            ReasonPhrase = "Error Reason phrase"
        };
        throw new HttpResponseException(resp);
 
    }
}

Answer 4

使用HttpResponseException如下：

throw new HttpResponseException(HttpStatusCode.InternalServerError)

或者另一种方式是：

var response = new HttpResponseMessage(HttpStatusCode.NotFound)  
    {  
        Content = new StringContent("some error"),  
            ReasonPhrase = "Not Found"  
    };  

    throw new HttpResponseException(response);