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

这将使您能够保持路线整洁，并允许您在将来传递多个参数。