1. ホーム
  2. rest

[解決済み] RESTリソースの命名規則はSingularとPluralのどちらを使用すべきですか?

2022-03-15 01:16:06

質問

私はRESTの初心者ですが、いくつかのRESTfulサービスでは、更新/取得/削除とCreateに異なるリソースURIを使用していることを確認しました。例えば、次のようなものです。

  • 作成 - 使用する /リソース を使い、POSTメソッド(複数を観察)を使っているところがある。 /resource (単数)
  • アップデート - 使用 /resource/123 PUTメソッドで
  • 取得 - 使用 /resource/123 GETメソッドで

このURIの命名規則について、私は少し混乱しています。リソースを作成する際に、複数形と単数形のどちらを使うべきなのでしょうか?それを決定する際の基準は何でしょうか?

どのように解決するのですか?

を使う前提で /resources は、quot;すべての"リソースを表現しているということです。もしあなたが GET /resources の場合、コレクション全体が返される可能性が高いです。にPOSTすることで /resources ということは、コレクションに追加していることになります。

ただし、個々のリソースは/resourceで公開されています。を実行すると GET /resource このリクエストは意味をなさないので、エラーになる可能性が高いです。 /resource/123 は完全に意味があります。

使用方法 /resource の代わりに /resources は、例えばファイルシステムとファイルのコレクションを扱う場合のやり方と似ており /resource はディレクトリで、個々の 123 , 456 というファイルがあります。

どちらの方法が正しいとか間違っているとかではなく、自分が一番好きな方法で行ってください。