在 Web API 中处理错误时返回 JSON

Question

我创建了 Web API，它接受四个输入参数，用于查询 Oracle 数据库并以 JSON 格式返回结果。现在，如果缺少任何输入参数或格式错误，我正在尝试处理 URI 中的任何异常。就像返回 JSON "error":"ROOM cannot be Empty or NULL" 如果 URI 中的 ROOM 是空的，比如 ROOM=&DOB_GT=01-SEP-05&DOB_LT=30-DEC-06&STATUS_TYPE=CMPLT

public class TGSDataController : ApiController
{
[HttpGet]
public HttpResponseMessage Getdetails(string ROOM, DateTime DOB_GT, DateTime DOB_LT, string STATUS_TYPE)
{
    if (string.IsNullOrEmpty(ROOM))
    {
        var resp = new HttpResponseMessage()
        {
            Content = new StringContent("ROOM cannot be Empty or NULL")
        };
        resp.Content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
        return resp;
    }
    List<OracleParameter> prms = new List<OracleParameter>();
    List<string> selectionStrings = new List<string>();
    prms.Add(new OracleParameter("ROOM", OracleDbType.Varchar2, ROOM, ParameterDirection.Input));
    prms.Add(new OracleParameter("DOB_GT", OracleDbType.Date, DOB_GT, ParameterDirection.Input));
    prms.Add(new OracleParameter("DOB_LT", OracleDbType.Date, DOB_LT, ParameterDirection.Input));
    prms.Add(new OracleParameter("STATUS_TYPE", OracleDbType.Varchar2, STATUS_TYPE, ParameterDirection.Input));

    string connStr = ConfigurationManager.ConnectionStrings["TGSDataBaseConnection"].ConnectionString;
    using (OracleConnection dbconn = new OracleConnection(connStr))
    {
        DataSet userDataset = new DataSet();
        var strQuery = "SELECT * from LIMS_SAMPLE_RESULTS_VW where ROOM = :ROOM and DOB > :DOB_GT and DOB < :DOB_LT and STATUS_TYPE= :STATUS_TYPE ";

        var returnObject = new { data = new OracleDataTableJsonResponse(connStr, strQuery, prms.ToArray()) };
        var response = Request.CreateResponse(HttpStatusCode.OK, returnObject, MediaTypeHeaderValue.Parse("application/json"));
        ContentDispositionHeaderValue contentDisposition = null;
        if (ContentDispositionHeaderValue.TryParse("inline; filename=TGSData.json", out contentDisposition))
        {
            response.Content.Headers.ContentDisposition = contentDisposition;
        }
        return response;
    }

使用我上面的代码，它确实返回 ROOM 不能为 Empty 或 NULL 如何得到 "error":"ROOM cannot be Empty or NULL"。还有什么方法可以处理 URLI 中的错误并将 JSON 响应返回为"error":"Poorly Formed URI"

Answer 1

首先 WebAPI 可以自动将任何对象序列化为 JSON，无需您手动尝试构建 HttpResponseMessage。

通过使用

Content = new StringContent("ROOM cannot be Empty or NULL")`

您只需在响应正文中添加一个普通字符串即可。

改为使用 Request.CreateResponse 扩展方法来构建一个 HttpResponseMessage，其中的任何对象都被序列化为 JSON。

return Request.CreateResponse(HttpStatusCode.BadRequest,resp);

默认情况下，WebAPI 将根据请求标头对 XML 或 JSON 上的响应进行序列化。 为了强制 JSON 序列化，只需将其添加到您的 Application_Start()

GlobalConfiguration.Configuration.Formatters.Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);

现在关于异常。 默认情况下，WebAPI 会自行处理抛出的异常，并返回默认的错误响应。

如果您想拦截此功能并在异常时返回您自己的自定义响应，您应该实现 ExceptionFilterAttribute

    public class BALExceptionFilterAttribute : ExceptionFilterAttribute
{
    public override void OnException(HttpActionExecutedContext actionExecutedContext)
     {
        base.OnException(actionExecutedContext);
        actionExecutedContext.Response = actionExecutedContext.Request.CreateResponse(HttpStatusCode.BadRequest, new { error = actionExecutedContext.Exception.Message });
    }
}

并将其添加到您的应用程序启动中

GlobalConfiguration.Configuration.Filters.Add(new BALExceptionFilterAttribute());

最后，如果您有 WebAPI 2.1，您可以使用 Global ExceptionHandling 处理 URL 错误

否则这里有一些相关的问题。 custom-error-pages-for-non-existant-directory-file-web-api-not-controllers how-to-handle-webapi-error-404

Answer 2

您可以轻松地构建一个带有您想要返回的错误的匿名类型。

if (string.IsNullOrEmpty(ROOM))
    {
        return this.Request.CreateResponse(
        HttpStatusCode.BadRequest,
        new { error= "ROOM cannot be empty or NULL" });
        resp.Content.Headers.ContentType = 
           new MediaTypeHeaderValue("application/json");
        return resp;
    }

Answer 3

尝试访问您的 Web 服务的客户端不会收到 JSON 格式的错误；相反，它将在客户端遇到错误。糟糕的 URI 不会让客户端到达返回 JSON 数据的服务器。

这应该回答你的第二个问题。

对于第一种，您有两个选择：您可以手动构建 JSON 返回，或者，您可以使用 JSON 库。

要手动完成，您可以使用以下方法：

    {"error":"ROOM cannot be Empty or NULL"}