ペイロードとは？API初心者向けにリクエスト本文・送信データを解説

ペイロードとは、通信やAPIで送るデータのうち、実際に届けたい中身のことです。

APIでは、リクエスト本文やレスポンス本文に入るJSONデータを指して使われることが多いです。

ペイロードとは

ペイロードは、荷物で例えると「箱の中身」です。

通信には、宛先や形式などの情報も含まれます。その中で、本当に相手へ渡したいデータ本体がペイロードです。

APIでの例

たとえば、新しいユーザーを作成するAPIへ次のJSONを送るとします。

{
  "name": "Ada",
  "email": "ada@example.com"
}

このJSON部分がペイロードと呼ばれることがあります。

ヘッダーとの違い

HTTP通信では、ヘッダーと本文があります。

たとえば、Content-Type: application/json はヘッダーです。ユーザー名やメールアドレスのJSONはペイロードです。

リクエストとレスポンスの両方にある

ペイロードは、リクエストだけでなくレスポンスにもあります。

リクエストでは、クライアントからサーバーへ送るデータです。レスポンスでは、サーバーからクライアントへ返すデータです。

初心者が注意する点

ペイロードという言葉は、文脈によって少し意味が変わります。

• APIの本文データ
• イベント通知の中身
• JWTの中に含まれる情報
• メッセージキューで送るデータ

まずは「実際に運びたいデータ本体」と理解しておけば問題ありません。

HTTP全体の中で見る

POST /api/todos HTTP/1.1
Content-Type: application/json
Authorization: Bearer ...

{"title":"数学の課題"}

最初の行はmethodとpath、headerは形式や認証などの付加情報、空行より後のJSONがこの例のpayloadです。payloadとbodyは同じ意味で使われることがありますが、分野によってpayloadが指す範囲は異なるため、何の中身かを確認します。

成功例は、DevToolsでheaderとpayloadを分け、Content-Typeと実際の形式が合うか確認することです。失敗例は、認証tokenをJSON本文へ入れたり、機密payloadをそのままログへ残したりすることです。

確認問題

Content-Type: application/jsonはpayloadでしょうか。これはbodyの形式を伝えるheaderで、JSON本文そのものがpayloadです。

リクエスト全体はHTTPリクエスト読解、応答のstatus・header・bodyはAPIレスポンスの読み方を参照してください。

まとめ

ペイロードは、API通信などで送るデータ本体です。ヘッダーは補足情報、ペイロードは中身と分けて考えると、HTTPやAPIの理解が進みます。

×

PR

×

PR