在Restful API设计中应该返回空列表[] 200/204或404吗？[重复]

Question

例如，有一个宁静的 API GET http://luexu.com/users/{页面} 来列出第 N 页中的用户。假设每个页面中有 20 个用户。数据库中总共有 100 个用户。GET http://luexu.com/users/5 返回第 80 个到第 100 个用户。

那么queryGET怎么样http://luexu.com/users/10？这是所有用户中的一个。返回空列表、空数组[]或404，哪种设计更好？

200?

{
    "code": 200,
    "msg": "OK",
    "data": []
}

还是204？

{
    "code": 204,
    "msg": "OK",
    "data": []
}

还是404？

{
    "code": 404,
    "msg": "Not Found",
    "data": null
}




Answer 1

返回404不适合你有部分页面的情况（例如你有85个用户），所以我会选择一个空列表，当你有一个二进制问题，资源找到与否时，404套件更好。

我会看看以下类似的问题：Rest服务返回404

Answer 2

这是一个没有“最佳”答案的问题。

你所能做的就是查看选项，然后选择最适合你的方案的选项。

根据经验，我个人避免退回404。原因是不清楚你为什么得到404。你可能会得到404，因为你的网址是错误的，所以如果你在没有数据的情况下选择退回404，那么你最终会陷入不清楚的境地。你怎么知道你为什么得到404？这不好。

返回一个空数组的200很好。返回204也很好。

重要的是做出选择，保持一致并记录选择，这样你的API的用户就知道你做出了这个选择以及为什么。

一致性和清晰性，以此为目标。

Answer 3

那么代码204怎么样？

在HTTP中，204 No Content意味着非常特殊的东西——消息体的长度为零字节。

204(无内容)状态代码表示服务器已成功完成请求，并且响应有效负载正文中没有要发送的附加内容。

因此，例如，如果您要发送json编码的文档，则不应考虑它。

如果空列表是资源的可接受表示形式，则可以使用200作为响应代码。例如，考虑堆栈溢出本身的URI。

https://stackoverflow.com/questions/tagged/cqrs 或域驱动设计或事件溯源？sort=最新

截至2019-06-01，带有这些标签的问题不到999页，但服务器计算此页面的正确表示没有问题（包括编号最高的页面为426的信息）。因此，200的语义非常合适。

404表示没有可用的资源表示。所有4xx类响应代码都表示请求出错——在这种情况下，它表明客户端在URI上犯了错误。这可能是暂时的情况（您现在不应该询问该资源）。所以如果您想指示的是客户端已经离开了域协议的快乐路径，这也没关系。

怎么选？我从HTTP规范中的这个观察开始

服务器应该发送一个表示，其中包含对错误情况的解释，以及它是暂时的还是永久的。

那么哪个对客户端有用呢？问题的表示，还是空集合的表示？当相同的资源被用于不同的事情时，这可能是一个具有挑战性的问题。