用于检索多对多关系结果的 REST 端点设计

Question

我已经阅读了许多其他关于如何安静地设计多对多关系的帖子；但是，我找不到我想要的答案。

基本上，我在数据库中有 2 个表和另一个连接这 2 个表的多对多表。 为简单起见，我们称它们为：

• 课程（CourseID, CourseName）
• 讲师（InstructorID，InstructorName）
• CourseInstructor（CourseID、InstructorID、lectureRoomName）（多对多）

我有两个问题：

1) 我应该如何获取 CourseInstructor 表中的所有条目。

GET /courses/instructors 正确吗？ （或GET /instructors/courses 或两者兼有）

或者我应该有一个名为 /coursesinstructors 的单独端点

2) 我还希望能够通过传入 CourseName 来获取 CourseInstructor 表中的所有行。

如果我正在寻找课程，我想我通常会这样做，/courses?name=coursename。而且，我可能会使用端点/courses/{courseId}/instructors/{instructorId} 在多对多表中搜索特定条目。

因此，我很好奇这样的工作：/courses?name=coursename/instructors（这甚至可能吗？）

另一种选择是使用另一个名为/coursesinstructors 的端点，我可以使用/courseinstructor?name=coursename 来获得结果。

或者我应该通过以下方式拨打 2 次电话以获得结果： - 通过/courses?name=coursename获取id - 并关注courses/{id}/instructors

除了我上面提出的建议和解决方案之外，我对任何其他建议和解决方案持开放态度（无论如何我不确定我的解决方案是否正确）。

Answer 1

对于第一种情况，这实际上取决于您的用例是什么。 GET /courses/instructors 意味着（仅）检索讲师，所以我个人会选择 GET /courses 和 embed 讲师。

至于第二种情况，/courses?name=coursename 应该足够好（加上/courses/{courseId}/instructors/{instructorId} 用于向下钻取到特定条目）。 2 个电话是另一个有效的选项。但是，根据RFC 3986，/courses?name=coursename/instructors 这样的 URL 似乎无效。

Answer 2

如果您确实需要 (1)，所有课程-讲师配对的完整转储，那么我认为您最好的选择是支持

GET /course-instructors
GET /course-instructors?courseName=whatever

然后，您可以链接或嵌入课程和讲师。

{
    "course": "/courses/12",
    "instructor": "/instructors/54"
}

{
    "course": {
        "name": "Political Science",
        ...
    },
    "instructor": {
        "name": "Hober Mallow",
        ...
    }
}

您返回的内容取决于客户的需求。也许您返回简短信息加上完整表示的链接，或者也许只返回链接是可以的，因为课程和讲师（应该！）高度可缓存。

顺便说一句，我认为您最好不要再考虑数据库如何存储数据，而是考虑客户需要您的 API 提供什么。