REST API命名規則：URL、メソッド、JSONキー
6 分で読了
適切に命名されたREST APIは直感的で一貫性があり、自己説明的です。これらの規則はほとんどの本番APIで採用されています。
URLパスの規則
- URLパスにはkebab-caseまたは小文字を使う：
/user-profiles - コレクションには複数形の名詞を使う：
/users、/orders - 個別のアイテムにはリソースIDを使う：
/users/123 - サブリソースをネストする：
/users/123/orders - URLに動詞を入れない：
POST /create-userではなくPOST /users
HTTPメソッド
| メソッド | 用途 | 例 |
|---|---|---|
| GET | 読み取り | GET /users/123 |
| POST | 作成 | POST /users |
| PUT | 全体更新 | PUT /users/123 |
| PATCH | 部分更新 | PATCH /users/123 |
| DELETE | 削除 | DELETE /users/123 |
JSONレスポンスのキー
camelCase（Googleスタイル）またはsnake_case（GitHub/Stripeスタイル）を使います。どちらか一つを選び、すべてのエンドポイントで一貫させましょう。
クエリパラメータ
snake_caseまたはcamelCaseを一貫して使います：?page_size=20&sort_by=created_at
フォーマットを変換
URLにはkebab-caseコンバーター、JSONキーにはcamelCaseまたはsnake_case。ハブもお試しください。