HTTP メソッド
HTTP メソッドは、データに対する「動作指示」のようなものです。
RESTful API では、主に4つのメソッドを使用します。これらはデータの4つの基本操作に対応します:
| HTTP メソッド | 用途 | 対応する操作 | 生活のたとえ |
|---|---|---|---|
| GET | データの取得 | 読み取り | メニューを見る |
| POST | データの作成 | 作成 | 注文する |
| PUT | データの更新 | 更新 | 注文を変更する |
| DELETE | データの削除 | 削除 | 注文をキャンセルする |
GET メソッド
GET はデータの取得に使います。まるで「今日は何の料理がありますか?」と店員に尋ねるようなものです。
// 获取所有用户 GET /api/users // 获取特定用户 GET /api/users/123 // 获取用户的订单 GET /api/users/123/orders
特徴:
- 安全な操作で、データを変更しません
- キャッシュ可能
- パラメータは URL に含まれます
POST メソッド
POST は新しいデータの作成に使います。まるで「宮保鶏丁を一つ注文します」と店員に伝えるようなものです。
// 创建新用户
POST /api/users
{
"name": "张三",
"email": "zhangsan@example.com"
}
// 创建新订单
POST /api/orders
{
"userId": 123,
"items": ["商品A", "商品B"]
}
特徴:
- サーバーの状態を変更します
- 冪等ではありません(複数回呼び出すと複数のリソースが作成されます)
- データはリクエストボディに含まれます
PUT メソッド
PUT はリソース全体の更新に使います。まるで「注文をこう変更してください」と言うようなものです。
// 更新用户信息
PUT /api/users/123
{
"name": "李四",
"email": "lisi@example.com",
"phone": "13800138000"
}
特徴:
- 冪等です(複数回呼び出しても結果は同じです)
- 通常、リソース全体を置き換えます
- リソースが存在しない場合は、新しいリソースが作成されることがあります
DELETE メソッド
DELETE はリソースの削除に使います。まるで「注文をキャンセルします」と言うようなものです。
// 删除用户 DELETE /api/users/123 // 删除订单 DELETE /api/orders/456
- 冪等です
- 指定したリソースを削除します
- 成功後、リソースは存在しなくなります
HTTP ステータスコード
サーバーがリクエストを処理した後、結果を知らせるステータスコードを返します:
| ステータスコード | 意味 | 説明 |
|---|---|---|
| 200 | OK | リクエスト成功 |
| 201 | Created | リソース作成成功 |
| 400 | Bad Request | リクエストエラー |
| 401 | Unauthorized | 未認証 |
| 404 | Not Found | リソースが存在しない |
| 500 | Internal Server Error | サーバー内部エラー |