rest - 为资源子集设计 REST API 的最佳实践

Question

给定这样的 URL 结构:

 GET           /user/giftcards/:id

当返回包含我所有礼品卡的列表时:

 GET           /user/giftcards

我的问题来了，如果我还想返回礼品卡的子部分(例如已收到或已发送)，URL 结构的最佳做法是什么？

今天我这样做了(但我知道这是错误的，因为 URL 应该代表名词/资源(这里:giftcard)

 GET           /user/giftcardsreceived
 GET           /user/giftcardssent

在我看来，有两个“更好”的解决方案:

 GET           /user/giftcards/received
 GET           /user/giftcards/sent

或

 GET           /user/giftcards?filter=received
 GET           /user/giftcards?filter=sent

我倾向于带过滤的请求参数解决方案，因为其他解决方案可能与基于 id 的 GET 冲突。

感谢任何指向正确方向的意见。

Answer 1

由于这对应于元素的子列表，因此应该由处理此类元素列表的同一资源提供服务。因此，在我看来，使用查询参数会更好。

以下链接可以为您提供更多提示:

• 设计 Web API - https://templth.wordpress.com/2014/12/15/designing-a-web-api/ .请参阅“过滤数据”部分

希望对你有帮助，蒂埃里