RESTfully 按属性获取

Question

在仅获取 items 时，以下哪个 URL 更符合 RESTful对 attribute 有一定的值(value)?

GET: /items/attribute/{value}

GET: /items/findByAttribute?attribute={value}

GET: /items?attribute={value}

请记住 GET: /items返回所有项目。

示例

GET: /shirts/color/FF9900

GET: /shirts/findByColor?color=FF9900

GET: /shirts?color=FF9900

Answer 1

我认为最后一个选项是正确的；-)

以下是对其他人的一些评论:

通常，与列表资源对应的路径元素之后的路径元素是元素的标识符。因此，如果您在此级别使用某些东西，则可以将其视为标识符...

您可以拥有管理特定字段的资源，但 URL 类似于 /items/{itemid}/fieldname .

您不应在 URL 中使用“操作名称”(在您的示例中为 findByAttribute)。 HTTP 方法应该对应于“ Action ”本身。如果您想支持 HTTP 方法的多个操作，请参阅此答案:How to Update a REST Resource Collection .

有一个关于如何设计搜索过滤器的问题:How to desing RESTful advanced search/filter .我认为你的用例如果有点简单并且使用查询参数适合你。

否则我写了一篇关于设计 Web API 的方法的文章。这可能对你有用。见此链接: https://templth.wordpress.com/2014/12/15/designing-a-web-api/ .

希望对你有帮助
蒂埃里