应该通过REST的路径部分或查询部分传递变量吗？
应该通过REST的路径部分或查询部分传递变量吗？
提问于 2016-04-14 17:35:11
我正在开发一个允许用户管理群组的应用程序。每个组包含一个名称、校园和数据类型。它们不属于任何特定的等级--从语义上讲，一个校园可以被认为有很多组，但考虑一个分布在许多校园的最高层的小组也是很自然的。
名称/校园/数据类型的组合是唯一的
NAME CAMPUS DATA_TYPE
---------------------------------------
LABS WEST IPv4
LABS WEST IPv6
LABS EAST IPv4
USERS NORTH userids
USERS WEST userids
USERS EAST userids例如，拥有DATA_TYPE of IPv4的西校区实验室组将包含与西校区实验室相关的所有IP子网。
现在，钻研这些数据的唯一要求是组。不需要收集所有西校区组的列表，例如，或者所有具有"IPv6“数据类型的组。然而，是所必需的，以获得所有有“实验室”组的校园的列表，也有必要为实验室获取所有的data_types。
那么，我应该如何创建我的端点呢？
备选案文1
很长但相当清楚的网址。
GET /groups/LABS/ (returns LABS groups across all campuses and data_types)
GET /groups/LABS/data_type/IPv4 (returns all IPv4 LABS groups across all campuses)
GET /groups/LABS/campus/WEST (returns all WEST LABS groups across all data_types)
POST /groups/LABS/campus/NORTH/data_type/IPv4 (create a new group)
POST /groups/LABS/campus/NORTH/data_type/userids (another new group)优势：
- 避免任何查询参数
缺点：
- 它代表了一个实际上不需要的层次结构。
- 它还要求应用程序同时支持组->校园->数据类型和组->数据类型->校园层次结构。
选项2
将组视为层次结构的唯一部分，并将“校园”和"data_type“视为非分层标识符：
GET /groups/LABS
GET /groups/LABS?campus=WEST
GET /groups/LABS?data_type=IPv4
GET /groups/LABS?campus=WEST&data_type=IPv4
POST /groups/LABS (POST data: {campus: "WEST", data_type: "IPv4})
POST /groups/LABS (POST data: {campus: "WEST", data_type: "IPv4})优势：
- 它似乎反映了"data_types“和”校园“的非层次结构，并且可以很容易地指定(比方说)没有data_type的校园(反之亦然)。
缺点：
- 我不完全确定这是查询参数的适当使用。
- 此外，它没有为组/校园/数据类型的任何唯一组合提供非常漂亮的"permalink“。
我倾向于选择2，这是表示这些数据的最好方法吗？还是我想错了？
回答 1
Stack Overflow用户
回答已采纳
发布于 2016-04-14 18:30:05
相反，我建议支持两个端点。从您的描述中可以清楚地看到，一个组并不是由名称唯一定义的，但是URI结构意味着它是唯一的。相反，使用一个合成id来唯一地标识一个组。
GET /groups
?name={}
?campus={}
?data_type={}
<- some collection of all groups that match whichever criteria are specified
POST /groups
-> { "name": "LABS", "campus": "WEST", "data_type": "IPv4" }
GET /groups/{id}
<- { "name": "LABS", "campus": "WEST", "data_type": "IPv4" }这种方法使您在将来决定添加新属性或希望通过data_type在所有组中搜索时具有更大的灵活性。
您可以在来自服务器(meh)的响应中包含唯一的ids，也可以包括超媒体链接，以提供有趣的关系，例如同名的所有其他组，或者在同一校园中。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/36630159
复制相关文章
相似问题
腾讯云开发者
