rest - REST api中请求资源摘要表示的最佳方式？

Question

我有一个 REST api 处理大量资源，客户。客户有时需要客户的缩写/摘要表示。什么是指定请求是摘要表示的好方法？

要获得客户 123 的完整表示，请执行以下操作：/customers/123

获得摘要表示是/customers/123/summary一种好方法吗？有更好的选择吗？

Answer 1

为了使您的解决方案可重用和灵活，我建议实施“过滤器”查询参数。在那里，您可以放置​​客户端所需的任何字段：

GET /customers/123?fields=id,first_name,last_name,email

这样，如果以后您需要为不同的任务创建不同的摘要，您将无需修改任何内容。

我不推荐/customers/123/summary，因为它不灵活。对于一种情况可能没问题，但如果客户端需要为不同的情况访问不同的属性，您将不得不调整资源（很可能通过返回比需要更多的字段）。如果您想“隐藏”字段名称，也许替代方法可能是这样的：

GET /customers/123?view=DESCRIPTION

其中“ DESCRIPTION”将描述摘要的类型。例如：

GET /customers/123?view=addresses_only // eg. returns billing and home address
GET /customers/123?view=short // eg. returns only id, first name, last name

这仍然很灵活，因为您可以轻松创建新视图。