API-интерфейс REST API URI - выборка по идентификатору или настраиваемым полем

Question

Я создаю REST API, и я хотел бы знать, каковы наилучшие методы URI. У меня есть «пользователи», у которых есть уникальное электронное письмо и идентификатор. Тогда я могу принести пользователю с помощью этого маршрута:

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

Должен ли я выставить 2 Differents маршрутов для того, чтобы принести либо ID или по электронной почте?

Я посмотрел API Github и использовал идентификатор Field для некоторых из ресурсов ressources (/: owner /: repo) и идентификационный номер для других.

Answer 1

Что я обычно делаю с конечными точками API REST, я беру идентификатор записи и кодирую (хешу).

Большая библиотека в узле hashids:
https://www.npmjs.com/package/hashids

Например:
GET/пользователи/1

становится:
GET/пользователи/o2fXhV

Это все зависит от что бы вы хотели, чтобы ваши конечные точки были. Многие крупные компании используют разные соглашения об именах. Выберите то, что вам нравится.