API の HTTP メソッドの概要: GET、POST、DELETE、PUT、PATCH

「API (アプリケーション プログラミング インターフェイス) は、特に Web サービスを操作する場合に、クライアントとサーバー間の通信を可能にするために HTTP メソッドを使用することがよくあります。これらのメソッドは、リソースに対して実行できる特定のアクション (取得、作成、更新、データの削除 - Web アプリケーションで構造化された対話を可能にする 最も一般的な HTTP メソッドをいくつか見てみましょう。"

1. GET: データの取得
GET メソッドは、サーバーからデータを変更せずに取得するために使用されます。これは REST API で最も一般的なメソッドであり、通常はユーザーの詳細、製品情報、アイテムのリストなどのデータを取得するために使用されます。

• 使用例:

  • ユーザーのリストまたは単一ユーザーのデータを取得します。
  • 説明や価格などの製品の詳細を取得します。
  • ホームページやブログなどの読み取り専用リソースへのアクセス 投稿。

• 特徴:

  • 安全: サーバーの状態は変更されません。読まれました-
  のみ。
  • 冪等: GET リクエストを繰り返すと同じ結果になります。
  • キャッシュ可能: データを変更せずに取得するため、 結果は効率化のためにキャッシュできます。

例:

GET /api/users/1

2. POST: リソースの作成
POST メソッドは、サーバー上に新しいリソースを作成するために使用されます。 POST リクエストを送信すると、サーバーは提供されたデータに基づいて新しいリソースを生成します。 GET とは異なり、POST は書き込み操作であり、サーバーの状態を変更できます。

• 使用例:

  • 新しいユーザー アカウントを作成します。
  • 新製品をカタログに登録します。
  • サポートの送信など、フォームを介してデータを送信する リクエスト。

• 特徴:

  • 非冪等: POST リクエストを複数回繰り返す 同一のデータを持つ複数のリソースを作成できます。
  • キャッシュ不可: 変更であるため、通常はキャッシュされません。 リクエスト。

• 例:
  
  

POST /api/users
Content-Type: application/json

{
    "name": "John Doe",
    "email": "john@example.com"
}

3. DELETE: リソースを削除しています
DELETE メソッドは、サーバーからリソースを削除するために使用されます。このメソッドを使用すると、クライアントは、識別子 (ID など) によって特定のリソースを削除するようにサーバーに指示できます。

• 使用例:

  • ユーザーのアカウントを削除します。
  • 在庫から製品を削除します。
  • 注文をキャンセルします。

• 特徴:

  • べき等: DELETE リクエストが繰り返されても、 結果は同じ最終状態になります。リソースが 削除されたか、すでになくなっています。
  • キャッシュ不可: データを変更するため、通常はキャッシュされません。 サーバー上で。

• 例:
  
  

GET /api/users/1

4. PUT: リソースを更新または置換しています
PUT メソッドは、既存のリソースを更新するか、リソースが存在しない場合はリソースを作成するために使用されます。 PUT を使用する場合、クライアントは更新したいリソースの完全な表現を送信します。 PUT は通常、リソースのすべてのプロパティが既知で提供される更新に使用されます。

• 使用例:

  • ユーザーのプロフィール情報を置き換えます。
  • 商品の詳細を上書きします。
  • 新しいコンテンツを含むブログ投稿を更新しています。

• 特徴:

• 冪等: 同じデータを含む繰り返し PUT リクエストには
  
  が含まれます 同じ効果があり、同じリソース状態が生成されます。

• キャッシュ不可:
  
  を変更するため、通常はキャッシュされません。 データ。

• 例:
  
  

POST /api/users
Content-Type: application/json

{
    "name": "John Doe",
    "email": "john@example.com"
}

このリクエストにより、ID 1 のユーザーが新しい名前「Jane Doe」と電子メール「jane@example.com」で更新されます。ユーザーが存在しない場合、実装に応じて、サーバーは新しいユーザーを作成することがあります。

5.パッチ: リソースを部分的に更新しています
PATCH メソッドは PUT に似ていますが、部分的な更新に使用されます。 PATCH を使用すると、リソースの完全な表現を送信する代わりに、クライアントは特定のフィールドのみを更新できます。これは、リソース全体を置き換えずに、リソースのいくつかの属性のみを変更する必要がある場合に便利です。

• 使用例:

  • ユーザーのメールアドレスを変更せずにのみ更新する その他の詳細。
  • 商品の在庫数のみを変更します。
  • 内容を残したままブログ投稿のタイトルを変更する 変更なし。

• 特徴:

  • べき等: PUT と同様に、PATCH リクエストを繰り返します。 同じデータは同じ効果を持ちます。
  • キャッシュ不可: 変更するため、通常はキャッシュされません。 操作。

• 例:
  
  

DELETE /api/users/1

このリクエストでは、ID 1 のユーザーの電子メール アドレスのみが更新され、他のフィールドはすべてそのままになります。

• GET: データを読み取ります (安全、冪等、キャッシュ可能)。
• POST: 新しいリソースを作成します (べき等ではなく、キャッシュ可能ではありません)。
• DELETE: リソースを削除します (冪等、キャッシュ不可)。
• PUT: リソースを完全に更新または置換します (冪等、キャッシュ不可)。
• パッチ: リソースを部分的に更新します (冪等、キャッシュ不可)。

各メソッドは特定の目的を果たし、REST API が一連の対話を提供できるようにして、クライアントがリソースを効率的に作成、読み取り、更新、削除できるようにします。これらのメソッドを理解することは、一貫性のある直感的な API の設計に役立ち、クライアントがサーバー リソースと効果的に対話できるようになります。

以上がAPI の HTTP メソッドの概要: GET、POST、DELETE、PUT、PATCHの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。