如何根据某些表以合理的方式决定资源

Question

我需要知道如何决定什么是资源，什么是子资源。我只需要为一些表创建uri。假设我有一个student表和studentclass（它给出了学生注册的班级的名称，可能还有更多的详细信息）表（N:1）。

我将使学生成为主要资源，并设计如下uri

http://home/someapi/v1/student/1/

遵循rest方法构建uri

Qus 1:要访问studentclass，我必须使用下面显示的哪个uri

1.http://home/someapi/v1/studentclass?studentid=1 or
2.http://home/someapi/v1/student/1/studentclass

我必须把学生班视为一个单独的资源吗？

和

Qus 2：假设表之间存在N： N关系，那么uri的设计应该如何？

Answer 1

我认为学生班级(或简称为“班级”)应该是一种不同的资源，因为班级可以在学生之间共享。因此，这个Uri将满足您的需要:

/v1/学生类？

Answer 2

我建议处理两个资源：学生和类。

您可以使用以下 URI 获取学生：

http://home/someapi/v1/students/1

请注意这里的复数，如果您想了解为什么应该使用复数：http://blog.apigee.com/detail/restful_api_design_plural_nouns_and_concrete_names/，请阅读本文。

如果一名学生可以注册到一个类，则它可能是该学生的属性，因此您可以返回以下JSON文档（例如）：

{
  "student": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "class": {
      "id": 10,
      "name": "Room Y"
    }
  }
}

您可以获取具有以下 URI 的特定类：

http://home/someapi/v1/classes/10

您可以使用以下 URI 获取给定班级的所有学生：

http://home/someapi/v1/classes/10/students

现在，如果您在学生和类之间有N-N关系，它将改变我关于JSON中学生表示的第一个提议。实际上，class关系将成为class资源的集合，而不是学生的嵌入属性，您应该使用以下URI：

http://home/someapi/v1/students/1/classes

意思是“检索学生#1的所有课程”。

您可以公开班级和学生资源。无需决定哪一个是主要的，因为它们描述了两种不同的东西。拥有 /students 和 /classes 允许您创建学生和班级，您可以链接它们等。

最后一点，建议使用查询参数(< code >？foo=bar)进行过滤。