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

Question

目前我有以下资源：

/api/user/12

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

/api/user/12/trips

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

但是我认为 /trip/ 是一个单独的资源，所以这将像这样继续：

/api/trip/5

返回 id=5 的行程信息

这是一个好方法吗？

Answer 1

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

要显示某个用户：

/api/user/{username}

显示所有用户：

/api/user

使用查询过滤所有用户。

/api/user?region=Italy

这是一篇不错的文章：http: //developer.immobilienscout24.de/wiki/Path_and_Query_Parameters

Answer 2

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

/api/users

含义：所有用户（集合）。

/api/users/12

含义：用户 12。

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

/api/users/12/trips

含义：全部trips为user12。

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

/api/trips/5

含义：行程 5。