API命名建议-findById findByName

Question

我正在创建一个新的API，并研究了一些良好的API命名约定。

例如，您有一个类似API：

GET - /users           | Get all users
GET - /users/:id       | Get user with :id
DELETE - /users/:id    | Delete user with :id
POST - /users          | Create a new user

现在，我想添加一条路由来按名称获取用户，以在前端实现自动完成/提前输入组件的后端路由。

有什么好的命名建议吗？

您如何看待：

GET - /users/name/:name       | Get user with :name

Answer 1

由于基本上只过滤用户，因此应使用查询参数来传递所有过滤器

/users?name=xxx&other=xxx

这将使您保持路由整洁，并在以后传递多个参数