RESTful APIリソースの命名における単数名詞の引数は何ですか?


12

RESTful URIに名前を付けるとき、リソースのコレクションを表すために複数形を使用することは一般に受け入れられていることを理解しています。代わりに単数名詞を使用するための引数について興味があります。


すべてがコレクションではないからでしょうか?
14年

シングルトンリソースが登場する場所ではありませんか?
チャネス14年

回答:


12

一部のリソースには単一のアイテムのみが含まれます。良い例は、レンダリングするデータを見つけるためにIDを必要としないすべてのものです。たとえば、非常に一般的なのはログインリソースです。(ユーザーとブラウザーのビューから)ログインは1つだけです。作成することも破棄することもできますが、複数のログインから選択できるインデックスアクションはありません。

同様の例としては、会社情報、出版社、連絡先フォームなど、単一のアイテムのみを表示するか、単一の作成アクションのみを許可する同様のものなど、ほとんど静的なページがあります。

単数形の名詞を使用するとコードの可読性が大幅に向上する場合は、議論の問題になる可能性があります。


5

なぜなら:

  1. 「チェリー」のような英語の複数規則は、特に英語があなたの母国語ではない場合、APIの開発中に考えるのに最適なものではありません。
  2. モデルからエンドポイントを生成したい場合がありますが、通常は特異です。上記ではうまく動作しません。
  3. 「通常、リストを表示するにはGetでクエリを開始します」という引数は、実際のユースケースを指すものではありません。そして、アイテムのリストと同じくらい、さらにそれ以上の単一のアイテムをクエリすることになります。
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.