REST API URI設計方法

Question

我正在為我正在構建的未開發應用程序進行我的第一個RESTful API設計，並且可以使用API​​ URI上的一些指針。

對於后台，該系統由臨床醫生用於獲取有關其患者的警報，因此，我將創建一個屏幕，該屏幕將顯示屬於分配給臨床醫生的所有患者的警報列表。

臨床醫生將能夠按患者姓名或警報類型查看警報。

我的第一個想法是使用URI使其真正簡單，如下所示：

/api/alerts獲取/api/alerts的完整列表
/api/alerts/123獲取指定警報的詳細信息
/api/alerts?user=mike按用戶獲取警報列表
/api/alerts?user=mike&groupby=patients按用戶和按患者組獲取警報列表

但是我開始有了第二個想法，並開始從用戶的角度考慮它，以及如何更好地顯示這種關系，這導致我：

/api/users獲取/api/users的完整列表
/api/users/mike獲取指定用戶的詳細信息
/api/users/mike/patients獲取所有指定用戶患者的詳細信息
/api/users/mike/patients/alerts alerts-為用戶患者獲取所有警報
/api/users/mike/patients/123/alerts獲取指定用戶患者的所有警報
/api/users/mike/patients/alerts?groupby=type獲取用戶患者的所有警報，並按警報類型分組。

因此，如有任何想法，意見，請問我是否走對了。

我應該選擇一種方法還是使用另一種方法？

干杯，邁克

Answer 1

在設計REST API時，您將重點放在資源上，據我所知，您的資源就是“警報”，這就是API所針對的“事物”。 因此，您的方法對我來說更有意義。