REST API路由URI - 按ID或自定义字段获取

Question

我正在构建REST API，我想知道什么是URI最佳实践。我有＆＃34;用户＆＃34;实体，具有唯一的电子邮件和ID。然后我可以使用以下路线获取用户：

 GET /users/{id}
 GET /users/{email}

我应该公开2条不同的路线，以便通过ID或EMAIL获取？

我查看了Github API，他们使用字段标识符作为一些资源（/：owner /：repo）和其他人的ID号。

Answer 1

我通常使用REST API端点做的是获取记录的ID并对其进行编码（哈希）。

节点中的一个很棒的库是hashids：
https://www.npmjs.com/package/hashids

例如：
GET / users / 1

变为：
GET / users / o2fXhV

这完全取决于您希望您的端点是什么。许多大公司使用不同的命名约定。选择适合自己的方式。