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

现在我想添加一个通过名称获取用户的路由，以在前端为 autocompletion/typeahead 组件实现后端路由。

有什么好的命名建议吗？

你怎么看：

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

Answer 1

由于您基本上只是过滤用户，因此您应该使用查询参数来传递任何过滤器

/users?name=xxx&other=xxx

这将使您的路由保持干净，并允许您在将来传递多个参数

API 命名推荐 - findById findByName

API Naming recommendation - findById findByName

naming

node.js

express