1. ホーム
  2. rest

[解決済み】REST APIの命名規則ガイドラインはありますか?[クローズド]

2022-04-10 22:54:20

質問

REST APIを作成する際、API内の命名規則(例:URLエンドポイントパスの構成要素、クエリストリングパラメータ)についてのガイドラインやデファクトスタンダードはあるのでしょうか? キャメルキャップが一般的なのか、アンダースコアが一般的なのか、その他は?

例えば

api.service.com/helloWorld/userId/x

または

api.service.com/hello_world/user_id/x

注:これはRESTful API設計の問題ではなく、最終的に使用されるパスの構成要素やクエリ文字列パラメータに使用する命名規則のガイドラインです。

何かガイドラインがあれば教えてください。

解決方法は?

キャメルキャップは避けた方がいいと思います。小文字を使うのが普通です。アンダースコアも避け、代わりにダッシュを使用します。

つまり、URLは以下のようになります(ご要望の通り、デザインの問題は無視します :-))。

api.service.com/hello-world/user-id/x