api - API设计中什么时候使用Scope和什么时候使用QueryParam？

Question

我们有一个返回 JSON 输出的端点。很少有消费者为此端点请求。但是特定的消费者只请求了一部分有效负载。那么，在这种情况下，我们是否应该使用范围来授权以及对信息进行切片？

要求如下：/endpoint1（范围为 user1）-> 给出 {shape:square, area:16, perimeter:16 }

/endpoint1（范围为 user2）-> 给出 {shape:square}

当我们只想分享很少的信息时，我们可以使用范围吗？

我们还了解到 QueryParam 仅用于过滤，例如给出所有正方形或矩形的形状。

我们的理解正确吗？

谢谢！

Answer 1

您可以按范围执行此操作，但出于可见性原因（管理员、超级用户、用户、访客），我更愿意这样做。在您的情况下，我认为为一个客户添加范围是一种矫枉过正。

我可能会这样做：

/endpoint1/shape

或者

/endpoint1/?fields=shape

最后，这是一个基于意见的事情，因为所有方法都会导致预期的结果。