Question

我正在使用新系统并建立我将要返回的错误合同。我正在尝试关注OData v4 Error Response structure。

由于这是一个C＃服务，似乎Exception对象和OData错误响应之间存在非常好的映射。但是，我们正在尝试确定错误响应对象是否可以包含其他任意属性。内部错误被明确声明为允许具有其他属性，因此以下内容有效：

{
  "error": {
    "code": "BadArgument",
    "message": "Previous passwords may not be reused",
    "target": "password",
    "innererror": {
      "code": "PasswordDoesNotMeetPolicy",
      "minLength": "6",
      "maxLength": "64",
      "minDistinctCharacterTypes": "2",
    }
  }
}

异常上的Data属性与此映射非常好，我们可以将内部异常上的每个值转换为错误的属性。因此，如果客户端向外部异常添加任意属性，是否可以将它们作为属性在根处公开。例如：

{
  "error": {
    "code": "BadArgument",
    "message": "PasswordDoesNotMeetPolicy",
    "target": "password",
    "minLength": "6",
    "maxLength": "64",
    "minDistinctCharacterTypes": "2",
  }
}

或者像这样的东西通常被认为是OData的“坏形式”？

Answer 1

如果直接在error对象上添加自定义属性，则会出现非标准错误响应。代码生成工具和第三方客户端无法识别自定义属性。

innererror属性是一个扩展点。 spec says：＆＃34;此对象的内容是服务定义的。通常，此对象包含有助于调试服务的信息。＆＃34;坚持innererror。

OData错误对象可以包含任意属性

1 个答案: