[解決済み】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
関連
-
[解決済み] RESTfulとRESTlessの違いについて
-
[解決済み] git リポジトリの命名規則はありますか?
-
[解決済み] 検証失敗または重複が無効な場合のREST HTTPステータスコード
-
[解決済み] Pythonの変数名や関数名の命名規則について教えてください。
-
[解決済み] RESTリソースの命名規則はSingularとPluralのどちらを使用すべきですか?
-
[解決済み] C#の定数の命名規則?
-
[解決済み】API paginationのベストプラクティス
-
[解決済み】列挙型の命名規則 - 複数形
-
[解決済み】Node.js内でリモートRESTコールを行うには? CURLは?
-
[解決済み】REST認証スキームの安全性
最新
-
nginxです。[emerg] 0.0.0.0:80 への bind() に失敗しました (98: アドレスは既に使用中です)
-
htmlページでギリシャ文字を使うには
-
ピュアhtml+cssでの要素読み込み効果
-
純粋なhtml + cssで五輪を実現するサンプルコード
-
ナビゲーションバー・ドロップダウンメニューのHTML+CSSサンプルコード
-
タイピング効果を実現するピュアhtml+css
-
htmlの選択ボックスのプレースホルダー作成に関する質問
-
html css3 伸縮しない 画像表示効果
-
トップナビゲーションバーメニュー作成用HTML+CSS
-
html+css 実装 サイバーパンク風ボタン
おすすめ
-
[解決済み] Apache Marathon REST APIを使用してDockerインスタンスをスケールアップする方法。
-
[解決済み] git リポジトリの命名規則はありますか?
-
[解決済み] jenkins restful apiのリファレンスはどこにありますか?[クローズド]
-
[解決済み】RESTful 認証
-
[解決済み】URIの単語の区切り文字にハイフン、アンダースコア、キャメルケースのどれを使うか?
-
[解決済み】有効なリクエストでありながら、データが空の場合の適切なRESTレスポンスコードは何ですか?
-
[解決済み】データのPOSTに対する400と422のレスポンス
-
[解決済み】RESTful APIで多対多の関係を処理するにはどうすればよいですか?
-
[解決済み] restfulなPOSTレスポンスのための「ベスト」プラクティス
-
[解決済み】REST APIの命名規則ガイドラインはありますか?[クローズド]