java - Spring Rest中用于编码基于和基于名称的API的最佳实践是什么

让我们考虑以下API。

/school/{schoolId or schoolName}
/school/{schoolId or schoolName}/students/{studentId or studentName}

我必须开发上述API。在春季REST中实现此目标的最佳方法是什么？我可以简单地将URL路径变量获取为字符串，并检查它是id还是名称，然后对其进行处理。

但是，还有其他更好的解决方案吗？

最佳答案

房间里有一头大象，学校名称或学生姓名不是唯一的。因此，建议不要使用它代替id，否则会烫手。


  
  / school / {schoolId或schoolName}
  


我将其分为两个终点

1. / schools / {schoolId}

如果找到，返回学校实体

HTTP-200
{
  "id" : "id-123",
  "name" : "worlds best school ever",
  "address" : "123 somestreet, some city, some state"
}

如果找不到，

HTTP 404 and an empty body

2. / schools？name =“世界上最好的学校”（其他可选内容，例如排序方式，分页等）

如果每个搜索条件至少找到一个实体

HTTP-200
[
    {
      "id" : "id-123",
      "name" : "worlds best school ever",
      "address" : "123 somestreet, some city, some state"
    }
]

如果没有根据搜索条件找到实体

HTTP-200
[]

  
  / school / {schoolId或schoolName} / students / {studentId或studentName}
  


这就引出一个问题，一个学生属于一个以上的学校，我不这么认为。在这种情况下，/ school / {schoolId或schoolName}是不必要/多余的信息。如果是这样，我将其更改为

1. / students / {studentId}

如果发现

HTTP-200
{
  "id" : "studentid-345",
  "name" : "Albert Einstein",
  "school_id" : "id-123"
}

如果找不到

HTTP 404 with empty body

2. / students？name =“ Albert Einstein”（其他可选内容，例如排序方式，分页等）

如果每个搜索条件至少找到一个实体

HTTP-200
[
    {
      "id" : "studentid-345",
      "name" : "Albert Einstein",
      "school_id" : "id-123"
    }
]

如果没有根据搜索条件找到实体

HTTP-200
[]