API验证错误格式

时间:2017-08-22 07:51:46

标签: api validation error-handling

1

{
  "errors": {
    "firstName": ["cannot be blank", "must be 10+ characters"],
    "lastName": ["cannot contain symbols"]
  }
}

2

{
  "errors": [
    { "path": "firstName", "message": "cannot be blank" }, 
    { "path": "firstName", "message": "must be 10+ characters" },
    { "path": "lastName", "message": "cannot contain symbols" }
  ]
}

您喜欢什么样的格式?为什么,它有什么优势?

1 个答案:

答案 0 :(得分:0)

我总是建议采用现有标准。媒体类型application/problem+json可能非常合适。其中的规范是https://tools.ietf.org/html/draft-nottingham-http-problem-07,更像是您的第二个示例:为每个验证或其他问题提供一份报告。