网址/API 架构最佳实践

  • 本文关键字:最佳 API 网址 rest url
  • 更新时间 :
  • 英文 :


我经常遇到这个问题,不知道最好的做法是什么。 因此,例如,我想要我的角度应用程序的三个端点:

  1. 列出我的所有患者页面
  2. 创建患者页面
  3. 患者的详细页面

我的大脑建议如下:

  1. /病人
  2. /
  3. 患者/添加
  4. /
  5. patient/{id}

这似乎有点不对劲,因为 2. 和 3. 可能会导致问题?好的,id 永远不会是"添加",特别是如果 id 是整数。

API 几乎也是如此。但是我们有 POST、PUT 等。 所以这个例子的变化有点像:

/
  1. api/measurement/dashboard ->所有用户(计数、组等(的所有测量的汇总信息
  2. /
  3. api/measurement/{user} -> 有关特定用户测量的聚合信息 (没关系,我想位测量包含心率、体重等数据。

创建这样的端点很常见吗?这是一种好的做法还是好的做法?

从我的角度来看

GET /patient
PUT /patient
POST /patient
GET /patient/{id} 

看起来还行。

对于第二部分

GET /api/measurement
GET /api/measurement?user={userId}&group={groupId} 

如果我正确理解上下文,应该可以在您的情况下工作。

最新更新