Rest API 中的过滤参数

Question

我有两个实体“人员”和“企业”，它们都有一个子资源（例如位置）

所以我有端点：

GET /persons/{id}/locations
GET /businesses/{id}/locations

现在我想要一个端点来过滤主要资源的位置。 如果我这样做：

GET /persons/{id}/locations?country={...}
GET /businesses/{id}/locations?country={...}

我将搜索特定人员/企业的位置。

过滤所有人的位置的最佳做法是什么 我有一些想法：

1. GET /persons/locations?country={...}   
2. GET /locations?entity=persons&country={...}

但不确定这些是否正常。

Answer 1

您可以使用扩展概念来处理实体之间的关系。

GET /persons

{
  "data": [
      {"person_id": 1},
      {"person_id": 2}
 ],
 "links": [ 
    {
        "rel": "locations",
        "href": "/person/1/locations"
    },
    {
        "rel": "locations",
        "href": "/person/2/locations"
    } 
  ]
}

GET /persons?expand=locations&country={...}   

{
  "data": [
      {"person_id": 1, "locations": [...]},
      {"person_id": 2, "locations": [...]}
  ]
}