REST API

RESTful APIの主要なHTTPメソッド

メソッド	説明	用途
GET	サーバーからリソースを取得する。	Read
POST	サーバーに新しいリソースを作成する。	Create
PUT	サーバー上の既存リソースを更新する。	Update
DELETE	サーバーからリソースを削除する。	Delete

GET

• 用途: データの読み取り。
• 例: GET /users/123 はユーザーID 123の情報を取得します。

POST

• 用途: 新規リソースの作成。
• 例: POST /users に新しいユーザー情報を送信し、新しいユーザーを作成します。

PUT

• 用途: データの完全な更新。
• 例: PUT /users/123 でユーザーID 123の情報を更新します。

DELETE

• 用途: リソースの削除。
• 例: DELETE /users/123 でユーザーID 123の情報を削除します。

REST APIのベストプラクティス

1. エンドポイントに名詞を使用:

   • リクエストの形成が直感的になります。
   • 例: GET /datasource や POST /articles
   • NG例: GET /datasource や POST /GetArticles

2. 確立されたデータ形式の使用:

   • JSONが最も一般的で人気のあるデータ形式です。

3. エラーハンドリングの実施:

   • 完全なエラーハンドリングと標準HTTP応答コードの使用が重要です。
   • 404,500等 詳しくはこちらをご覧ください。

おすすめ教材

LEARN REST API DESIGN
How do we design effective and safe APIs? も分かりやすい