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）。