对数据POST的响应是400 vs 422

我正在尝试用我正在开发的“类rest”API找出在不同场景中返回的正确状态代码。假设我有一个端点，允许以JSON格式POST'ing购买。它是这样的:

{
    "account_number": 45645511,
    "upc": "00490000486",
    "price": 1.00,
    "tax": 0.08
}

如果客户端发送给我“sales_tax”(而不是预期的“tax”)，我应该返回什么?目前，我要返回400分。但是，我开始质疑自己。我真的应该退回422吗?我的意思是，它是JSON(这是受支持的)，它是有效的JSON，它只是不包含所有必需的字段。

当前回答

案例研究:GitHub API

https://docs.github.com/en/rest/overview/resources-in-the-rest-api#client-errors

也许从著名的api复制是一个明智的想法:

There are three possible types of client errors on API calls that receive request bodies: Sending invalid JSON will result in a 400 Bad Request response: HTTP/1.1 400 Bad Request Content-Length: 35 {"message":"Problems parsing JSON"} Sending the wrong type of JSON values will result in a 400 Bad Request response: HTTP/1.1 400 Bad Request Content-Length: 40 {"message":"Body should be a JSON object"} Sending invalid fields will result in a 422 Unprocessable Entity response: HTTP/1.1 422 Unprocessable Entity Content-Length: 149 { "message": "Validation Failed", "errors": [ { "resource": "Issue", "field": "title", "code": "missing_field" } ] }

2018-09-17 08:46:05

其他回答

400 -请求验证失败，比如数据丢失，类型错误等等，所以它的状态是400。

422 -通过请求验证，但操作过程失败，因为请求数据，或它的一部分给操作一个错误，但被处理，并给出一个状态422。

2023-01-18 22:46:15

没有正确的答案，因为这取决于对请求的“语法”的定义。最重要的是你:

一致地使用响应代码在响应体中包含尽可能多的额外信息，以帮助使用API的开发人员弄清楚发生了什么

在大家因为我说这个问题没有正确或错误的答案而责怪我之前，让我解释一下我是如何得出这个结论的。

在这个特定的例子中，OP的问题是关于一个包含不同于预期键的JSON请求。现在，从自然语言的角度来看，接收到的键名与预期的键名非常相似，但严格来说，它是不同的，因此(通常)机器不会认为它们是等效的。

如上所述，决定因素是语法的含义。如果请求是以application/json的内容类型发送的，那么是的，请求在语法上是有效的，因为它是有效的json语法，但在语义上是无效的，因为它不匹配预期的内容。(假设有一个严格的定义，什么使问题中的请求在语义上有效或无效)。

另一方面，如果请求是以更特定的自定义内容类型(如application/vnd.mycorp)发送的。mydatatype+json，也许，确切地指定了期望的字段，那么我会说请求很容易在语法上无效，因此响应为400。

在这个问题中，由于键是错误的，而不是值，因此如果存在有效键是什么的规范，就会出现语法错误。如果没有有效键的规范，或者错误是带有值的，那么它将是语义错误。