0

我正在为我正在构建的新应用程序进行我的第一个 RESTful API 设计,并且可以使用 API 的 URI 上的一些指针。

作为背景,临床医生使用该系统来获取有关其患者的警报,因此我将创建一个屏幕,该屏幕将显示属于分配给临床医生的所有患者的警报列表。

临床医生将能够按患者姓名或警报类型查看警报。

我的第一个想法是使用 URI 保持简单,如下所示:

/api/alerts - 获取警报的完整列表
/api/alerts/123- 获取指定警报的详细信息
/api/alerts?user=mike- 按用户
/api/alerts?user=mike&groupby=patients获取警报列表 - 按用户和患者组获取警报列表

但我已经开始重新考虑并开始从用户的角度思考它以及如何更好地展示关系,导致我:

/api/users- 获取用户的完整列表
/api/users/mike- 获取指定用户
/api/users/mike/patients的详细信息 - 获取所有指定用户的详细信息 患者
/api/users/mike/patients/alerts- 获取用户的所有警报 患者
/api/users/mike/patients/123/alerts- 获取指定用户的所有警报 患者
/api/users/mike/patients/alerts?groupby=type- 获取用户的所有警报 患者和按警报类型分组。

所以如果我走在正确的轨道上,任何想法,意见。

我应该采用一种方法而不是另一种方法,还是同时使用它们?

干杯,迈克

4

1 回答 1

1

在设计 REST API 时,您关注的是资源,据我所知,您的资源是“警报”,这是您的 API 所针对的“事物”。因此,您的方法对我来说更有意义。

于 2013-06-27T20:39:14.643 回答