api - 从 REST API 返回非完整资源是否正确？

Question

我有一个示例资源，它是一个报价。假设每个报价都有 n 个报价项目，例如。5 或 7。这些商品可能具有不同的状态，例如“无效”。我的问题是我需要创建一个端点，该端点将为特定用户返回一个带有无效报价项的报价（我的资源），比如说。从这个端点开始，我最好只返回带有无效报价项目的提到的报价（因此可能会修剪一些报价项目）。报价也必须退回，而不仅仅是报价项目。我想知道从 REST 的角度来看返回资源但没有完整状态是否正确。示例端点 uri 的外观如何？

标签： apirest

Answer 1

如果响应并不总是包含完整的数据，我假设您期待像过滤器这样的东西。

如果您的 api 是列表 api，则可以使用filter。例如：/users?status=active，它只能返回活动用户集。

否则，如果您的 api 要返回单个对象的响应，那么您可以使用参数字段仅返回响应中的特定数据。例如：/users/user_id?fields=email,age