命名嵌套资源的REST最佳实践

Question

目前我有以下资源：

/api/user/12

返回有关使用id=12的用户的信息

/api/user/12/trips

返回用户12的行程列表及其信息

然而，我认为/trip/是一个单独的资源，所以它将继续如下所示：

/api/trip/5

返回有关使用id=5的行程的信息

这是一个很好的方法吗？

Answer 1

您应该始终使用复数来命名资源：

/api/users

含义:所有用户(集合)。

/api/users/12

含义:用户12。

对于与给定资源相关的嵌套资源，您可以执行以下操作：

/api/users/12/trips

含义：user 12的所有trips。

但是，您仍然可以使用以下URI来描述特定的trip：

/api/trips/5

含义: trip 5。

Answer 2

最佳实践是使用域的路径。

显示特定用户的步骤：

/api/user/{username}

要向所有用户显示以下内容：

/api/user

使用查询过滤所有用户。

/api/user?region=Italy

这里有一篇很好的文章：http://developer.immobilienscout24.de/wiki/Path_and_Query_Parameters