建模API Restful Resources以按预约编号查找患者

Question

我有以下表格：

约会
身份
价值
patient_id

患者
id
姓名
生日日期

如果按预约值搜索患者，创建API资源的最佳方法是什么？

选项1：GET /patient?appointment=111111
选项2：GET /appointment/{value} and return JSON Patient
选项3：using nested resources like GET /patient/{n}/appointment
选项4：有任何想法吗？

TKS

Answer 1

选项2 听起来更好：

只有一项更改 - 使用约会而不是约会。

获取/约会 s / {value}

（这里我假设您有患者和患者的预约摘要数据）。

您的其他选择是 -

选项1 ：GET /患者？约会= 111111 - 我更喜欢查询参数而不是搜索参数。见这 - REST API Best practices: Where to put parameters?

选项2 ：获取/预约/ {值}并返回JSON患者 - 根据我的说法，这很接近。

选项3 ：使用嵌套资源，例如GET /病人/ {n} /约会 - 您需要预约数据。 Hene，在预约后使用它。即/病人/预约/ {n}。 （如果你要这样做。）