REST API 包括/过滤附加字段/资源/集合

Question

我正在使用 Zend Framework 1.12.3 开发 REST API。有一个参数能够返回要返回的附加信息(其他集合/资源或父/子资源)会很有用。

例如。 http://api.example.com/project/:id?include=Company,Company.users

其中 Company, Company.users 代表项目分配到的公司和该公司的用户，因此这两个集合包含在否则不会包含的响应中。

我已经简要地阅读了有关此内容(在此处限制 API 返回的字段 http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api#limiting-fields )，但我想了解更多信息。

是否有关于此问题的最佳实践指南？你有什么例子可以重新分级吗？

您是否遇到过类似的问题(包括字段、过滤字段等)，您是如何解决的？

Answer 1

一些用于字段扩展/字段选择的语法示例:

Facebook field expansion .我非常喜欢这里允许子资源分页的语法。

领英的 field selectors

我们希望在我们的 API 上提供类似的功能，并采用与 Facebook 字段扩展类似的语法。不幸的是，没有多少库可以帮助解决这个问题，所以我们一直在滚动我们自己的实现。 (Java 有 yoga，scala 有 shona 处于早期阶段，但这些都没有帮助您使用 PHP)。