REST API中的最佳方式是请求资源的摘要表示形式？

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

要获得客户123的完整代表： /customers/123

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

---

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

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

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

链接地址: http://www.djcxy.com/p/70871.html

上一篇: Best way in REST api to request a summary representation of a resource?

下一篇: Java FileLock blocking without exceptions; waiting on the lock