Рекомендация по именованию 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

Теперь я хочу добавить маршрут для получения пользователя по имени для реализации внутреннего маршрута для компонента автозаполнения / typeahead во внешнем интерфейсе.

Есть предложения по хорошему именованию?

О чем вы думаете:

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

Answer 1

Поскольку вы будете в основном фильтровать пользователей, вы должны использовать параметры запроса для прохождения любых фильтров

/users?name=xxx&other=xxx

Это позволит вам поддерживать чистоту ваших маршрутов и пропускать несколько параметров в будущем