REST APIのベストプラクティス
概要
- リソース中心の設計
- HATEOASを使用
各メソッドの使い分け
GET
- リソースの取得POST
- リソースの作成PUT
- リソースの更新DELETE
- リソースの削除
リソース中心の設計
リソース | POST | GET | PUT | DELETE |
---|---|---|---|---|
/customers | 新しい顧客を作成 | すべての顧客を取得 | 顧客を一括更新 | すべての顧客を削除 |
/customers/1 | エラー | 顧客1の詳細を取得 | 顧客1の詳細を更新 (顧客1が存在する場合) | 顧客1を削除 |
/customers/1/orders | 顧客1の新しい注文を作成 | 顧客1のすべての注文を取得 | 顧客1の注文を一括更新 | 顧客1のすべての注文を削除 |