了解REST响应和HTTP状态代码

Question

我想知道我应该如何在我的REST API中响应。

有效示例：

http://blah.com/api/v1/dosomething/123

以上是有效的请求，目前我的HTTP状态为200，带有JSON响应

{
    "dosomething": {
        "status": "OK",
        "results": "123"
    }
}

现在我的问题是，如果传递的参数无效（我希望是一串整数），我是否返回200的HTTP响应并将错误状态传递回JSON响应中，还是应该传递类似HTTP的信息？ 400响应（错误请求），并在JSON响应中列出请求的错误/问题？

错误示例：

http://blah.com/api/v1/dosomething/123a

JSON响应：

{
    "dosomething": {
        "status": "ERROR",
        "errors": [
            "Value passed: |123a| must be a integer."
        ]
    }
}

同样，我的问题是我应该在请求传递的参数不是我期望的值的情况下传递200或400 HTTP状态吗？ 还是应该始终是200响应，因为请求正在运行？

什么是最佳做法？

Answer 1

使用404。始终。 404.否则，就是误解了URI和资源的性质。 如果http://blah.com/api/v1/dosomething/标识了该资源，而123a仅仅是该资源的参数，则其他代码可能有意义。 但这没有： http://blah.com/api/v1/dosomething/123 : http://blah.com/api/v1/dosomething/123标识资源。 如果不存在这样的资源，则返回404 Not Found 。

您可能拥有一些处理细节，可以同时处理这两个资源http://blah.com/api/v1/dosomething/123和http://blah.com/api/v1/dosomething/123a ，但这不是资源。 从罗伊·菲尔丁（Roy Fielding）的论文中 ：

“资源不是存储对象。资源不是服务器用来处理存储对象的机制。资源是概念性映射-服务器接收标识符（标识映射）并将其应用于当前映射实现（通常是特定于集合的深树遍历和/或哈希表的组合）以找到当前负责的处理程序实现，然后处理程序实现会根据请求内容选择适当的操作+响应。隐藏在Web界面后面；只能通过Web界面访问的客户端不能假设其性质。”

Answer 2

由作者编辑：422是错误的答案。 我误解了最初的问题并给出了无效的答案。 请参阅@fumanchu的回复： https ://stackoverflow.com/a/10955717/441250。 我下面的回答是错误的。

我建议使用“ 422无法处理的实体”，并在响应的正文中包含失败信息。

422（不可处理实体）状态代码表示服务器
了解请求实体的内容类型（因此
415（不受支持的媒体类型）状态码不正确），并且
请求实体的语法正确（因此为400（错误请求）
状态代码不正确），但无法处理其中的说明。 例如对于如果XML可能会出现此错误情况
请求主体包含格式正确的（即，语法正确的），但是
语义错误的XML指令。

处理错误时，使用“ 200 Ok”或任何其他状态代码是不可接受的。

PS状态代码列表： http : //www.iana.org/assignments/http-status-codes/http-status-codes.xml

Answer 3

HTTP 400用于表示HTTP请求本身存在问题（例如无效的HTTP标头）。 尽管您没有收到期望的参数，但该请求仍然是有效的HTTP请求，因此我将返回200响应，但在JSON中包含缺少的参数的详细信息。