REST APIルートURI - IDまたはカスタムフィールドでフェッチする

Question

私はREST APIを構築しています。私はURIのベストプラクティスを知りたいと思います。私はユニークな電子メールとIDを持つ「ユーザー」エンティティを持っています。そして、私はこのルートを使用してユーザーをフェッチすることができます

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

私はどちらかIDまたは電子メールでフェッチするために、2つの貴様のルートを公開するべきでしょうか？

私はGithub APIを見て、いくつかのressources（/：owner /：repo）と他のID番号にField IDを使用しました。

Answer 1

REST APIのエンドポイントでは、通常、レコードのIDを取得してエンコード（ハッシュ）します。

ノードに大きなライブラリhashidsです：たとえば
https://www.npmjs.com/package/hashids

：
GET /ユーザー/ 1

は次のようになります。
GET /ユーザー/ o2fXhV

それはすべてが依存あなたのエンドポイントをどんなものにするか。多くの大企業は異なる命名規則を使用しています。あなたのために何が正しいかを選択してください。