HTTP リクエストメソッド

モジュールで API 呼び出しを設定する場合、HTTP リクエストメソッドを選択する必要があります。 この記事では、使用可能な方法と、それぞれの方法を選択する理由について説明します。

HTTP メソッド

次のいずれかの HTTP メソッドを使用します。

  • GET:パラメーターに基づいて web サーバーからデータを取得します。 GET は、指定されたリソースの表現をリクエストし、成功した場合は、リクエストされたコンテンツを含む 200 OK 応答メッセージを受け取ります。
  • POST:パラメーターに基づいて web サーバーにデータを送信します。 POST リクエストには、ファイルのアップロードなどのアクションが含まれます。 複数の POST を使用すると、1 つの POST とは異なる結果になる可能性があるので、意図せずに複数の POST を送信する場合は注意が必要です。リクエストが成功した場合は、200 OK の応答 POST ッセージが表示されます。
  • PUT:パラメーターに基づいて、web サーバー内の場所にデータを送信します。 PUT リクエストには、ファイルのアップロードなどのアクションが含まれます。 PUT と POST の違いは、PUTのべき等であるということです。つまり、1 回の PUT が成功した場合の結果は、多くの同一の PUT と同じになります。PUTが成功すると、200 件の応答メッセージ(通常は 201 件または 204 件)が表示されます。
  • PATCH: (一部の API 呼び出しモジュールでは使用できません)パラメーターに基づいて、web サーバー上のリソースに部分変更を適用します。 PATCH はべき等ではありません。つまり、複数の PATCH の結果として、意図しない結果が生じる可能性があります。 リクエストが成功した場合は、200 件の応答 PATCH ッセージ(通常は 204 件)が返されます。
  • DELETE:パラメーターに基づいて、指定されたリソースを web サーバーから削除します(リソースが存在する場合)。 リクエストが成功した場合は、200 OK の DELETE ッセージが返されます。
recommendation-more-help
7e1891ad-4d59-4355-88ab-a2e62ed7d1a3