REST字段过滤器使用

Question

我正在设计一个RESTful API，我问自己有关过滤器字段的问题。

在我的查询中，我希望用户能够选择他想要在响应中获得的字段。我很确定这是字段过滤器作业给我请求的字段，但经过一些重新调整，我发现大多数时候它用于在字段上添加标准，作为IF。用户是否需要显示或隐藏字段而Api每次都会返回完整的资源？

我还有一个关于这种过滤器的URI表示的问题。它应该是/ foo吗？fields = [bar1，bar2]？

由于

Answer 1

拥有一个可以指定要返回的字段的资源并不常见，默认情况下会返回所有字段。如果您的资源有很多字段或某些字段的值非常大，那么最好有一种方法来指定要返回的字段。

在REST中，没有关于如何设计过滤器网址的严格规定。使用GET参数确实很常见，因为它们可以是可选的，不必按任何特定顺序排列。您对/foo?fields=[bar1,bar2]的提议似乎没有问题，但我会亲自放弃括号。

Answer 2

Google Compute Engine API使用＆＃39;字段＆＃39;请求参数（参见documentation）。语法足够灵活，允许用户选择/限制嵌套元素。你可能会发现它很有用。

Answer 3

Yoga是一个框架，允许您使用可选字段部署自己的REST API。这可以减少到服务器的往返，并提高性能。