RESTful搜索深度嵌套资源

Question

我需要实现一个在我看来更适合SOAP而不是RESTful服务的搜索，因此我正在努力将其表达为RESTendpoint。

公司（companyId）
合同（Contractd，companyId，privilegeGroupId）
PrivilegeGroup（privilegeGroupId，privilegeId）
特权（privilegeId）

主键以粗体显示。

FindPrivilegesByCompanyId

我已经尝试了很多方法，试图通过某种REST请求来解决这个问题，但没有什么能真正说服我，因为特权和公司没有直接的关系
实际关系由以下长URI表示：

/公司/{companyId}/合同/特权组/特权

然而，尽管这个URI说的是事实，但将其公开给API客户机似乎不是一个好主意。因此，我试图想出一些替代方案：

• GET /companies/{companyId}/权限
• 获取 /privileges/search？companyId={companyId}

你知道如何处理这些情况吗？如何在RESTful API中表达这些类型的查询？有可能吗？我认为从理论上讲，这个查询的结果甚至不是REST术语中的资源。

注意：API已经公开了域模型每个对象的CRUD操作。

Answer 1

如果您觉得资源之间没有直接关系，可以使用查询参数根据其他资源进行筛选。例如：/特权？company\u id=$company\u id

（IMO，您在示例url中提到的搜索一词在这种情况下是不需要的。即使搜索是发生的事情，它也可以被视为使用另一个资源id的过滤器）

Answer 2

我认为从理论上讲，这个查询的结果甚至不是REST术语中的资源。

它是。

REST中信息的关键抽象是资源。任何可以命名的信息都可以是资源

在REST中，URI只是资源的标识符。例如，如果我们想检索Acme Corporation的特权，那么这个URI是完全“restful”的

/7B7F1B30-7A84-4406-8D88-FAC9B647AC12

拼写对其他人来说无关紧要。

您的实现框架和您的API消费者可能更喜欢可破解的URI；但这不是REST约束。

此外，没有REST约束要求域模型中的每个实体都有一个URI。“您的资源模型不是您的域模型”。

简而言之，如果您有一个生成此查询结果表示的endpoint，并且需要在标识符中编码一个公司id来进行查找，那么这些都可以。

/7B7F1B30-7A84-4406-8D88-FAC9B647AC12/{companyId}
/7B7F1B30-7A84-4406-8D88-FAC9B647AC12?{companyId}
/{companyId}/7B7F1B30-7A84-4406-8D88-FAC9B647AC12
/7B7F1B30-7A84-4406-8D88-FAC9B647AC12;{companyId}

困难的部分是试图选择语义上有意义/可识别的拼写；本质上与您在代码中尝试命名变量时遇到的问题相同，并且受到类似的限制，即：编译器不在乎，您编写代码是为了与其他人进行清晰的通信。

您可能会查看您支持的用例以了解有关拼写的想法，但您可能正在提供某种特权“摘要”，类似于帐户摘要或资产负债表。