Rest API - 列表项的预期 http 代码响应

Question

场景： 以下 Rest api 列出属于特定订单的产品（在路径 {orderid} 中给出其 id）

/api/order/{orderid}/products

什么是最好的/推荐的回应

/api/order/123/products 订单 123 不存在，为什么？

选项

1. 404 未找到
2. 200 个空数组
3. 其他

Answer 1

404 表示client error，表示“源服务器没有找到目标资源的当前表示或不愿意透露存在的表示”。

大致上，您是在向客户（和中间组件）报告客户在请求该资源时犯了错误。

这可能是一个不错的选择 - 资源被列为路径段这一事实意味着 hierarchy，如果资源不存在，那么它的从属资源也不存在。

换句话说，如果/api/order/123返回404，那么所有前缀为/api/order/123/的资源在语义上是一致的（但不是必须的）也返回404。

为什么？

因为你的服务器的实际实现应该隐藏在统一接口后面。

统一界面的关键在于，客户端无法分辨出它不是在与 1990 年代的通用网站对话。就它而言，/api/order/123/products 可以是一个名为 products 的文件，位于名为 /api/order/123 的目录中。

如果我们在目录不存在的情况下尝试从该路径读取，那么文件系统会发生什么？文件系统会返回错误（ENOENT ？），然后 Web 服务器通常会向客户端返回 404 响应。

您的 REST API 是一个适配器，它使您的系统看起来像一个网站。