为具有多对一关系的资源设计 GET 的 RESTful 方式答案

【问题标题】：RESTful way to design GET for a resource with many to one relation为具有多对一关系的资源设计 GET 的 RESTful 方式
【发布时间】：2021-03-30 06:56:40
【问题描述】：

我正在设计一个包含媒体资源列表的音乐媒体库。

GET /medias（所有媒体资源） GET /medias/1（获取一个媒体资源）

但媒体也通过媒体资源内的目录 ID 绑定到目录

...
{
   id: 1
   name: <media name>
   catalogId: 5
},
{
   id: 2
   name: <media name>
   catalogId: 5
}
...

我想设计一个 RESTFul 端点，允许通过资源 ID 获取资源并通过目录 ID 获取资源列表。对我来说，这听起来像是一个过滤器，所以......

再次通过媒体id获取单个媒体资源

GET /medias/1

按目录 ID 获取所有媒体

GET /medias?catalogId={5}

这很好，因为它将查询保留在媒体域内，但我试图了解这种方法的权衡。是否为这种类型的“外来”键行为保留查询？我理解正确吗？

【问题讨论】：

标签： api rest

【解决方案1】：

是否为这种“外来”键行为保留查询？

不是 REST。

REST 不关心您对资源标识符使用什么拼写约定，不关心您如何设计资源模型，也不关心资源的底层实现是什么。

【讨论】：