ヘッダ
ヘッダとは、HTTPリクエストおよびレスポンスに含まれる要素であり、クライアントとサーバ間で必要な情報をやり取りするために使用されます。リクエストとレスポンスの双方でヘッダは使用されますが、それぞれに含まれるヘッダの内容は異なることが多いです。
1. リクエストヘッダの例
代表的なリクエストヘッダの項目をいくつか紹介します。
1.1 Content-Type
リクエストボディのデータ形式を指定するヘッダです。サーバはこのヘッダを参照して、受け取ったデータをどの形式として解釈すべきかを判断します。例えばapplication/jsonはJSON形式、text/plainはプレーンテキスト形式を表します。
JSON形式のデータを送信する場合は以下のように指定します。
Content-Type: application/json
プレーンテキストのデータを送信する場合は以下のように指定します。
Content-Type: text/plain
1.2 Authorization
認証情報を格納するヘッダです。主にユーザ認証とアクセス制御のために使用され、Bearer <token>という形式でトークンの文字列が指定されます。この形式はJWT(JSON Web Token)やOAuth 2.0などの認証方式でよく利用されます。認証が必要なAPIにリクエストを送る際は、このヘッダにトークンを含める必要があります。
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
この例では、Bearerの後にトークン文字列を指定しています。サーバはこのトークンを検証し、リクエストの送信者が正当なユーザであるかを確認します。
1.3 User-Agent
リクエストを送信しているクライアントの情報を格納するヘッダです。ブラウザの種類やバージョン、OS情報などが含まれます。サーバ側ではこの情報をもとに、アクセスログの記録やクライアントごとのレスポンスの最適化などに活用することがあります。
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
この例では、macOS上のブラウザからリクエストが送信されていることがわかります。
1.4 Accept
クライアントが期待するレスポンスのデータ形式をサーバに伝えるヘッダです。例えばapplication/jsonが指定されている場合、サーバはJSON形式でレスポンスを返すことが期待されます。サーバが指定された形式に対応していない場合は、エラーレスポンスが返されることがあります。
Accept: application/json
この例では、クライアントがJSON形式のレスポンスを期待していることをサーバに伝えています。
1.5 カスタムヘッダ
標準的なヘッダ以外に、アプリケーション固有の情報を追加したい場合に使用されるヘッダです。X-から始まる名前で記載することが一般的ですが、X-の付与は必須ではありません。
X-Request-ID: 550e8400-e29b-41d4-a716-446655440000
この例では、リクエストを一意に識別するためのIDをカスタムヘッダとして付与しています。サーバ側でこのIDをログに記録することで、問題が発生した際にリクエストを追跡しやすくなります。
2. レスポンスヘッダの例
代表的なレスポンスヘッダの項目を紹介します。
ステータスラインはレスポンスの最初の行に記載され、プロトコル、ステータスコード、メッセージを示します。
以下はレスポンスヘッダの例です。
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 128
Cache-Control: max-age=3600
Server: uvicorn
2.1 Content-Type
レスポンスボディのデータ形式を示すヘッダです。クライアントはこのヘッダを参照して、受け取ったデータをどの形式として解釈すべきかを判断します。リクエストヘッダのContent-Typeと同じ名前ですが、レスポンスではサーバが返すデータの形式を示す役割を持ちます。
JSON形式のデータを返す場合は以下のように指定されます。
Content-Type: application/json
HTML形式のデータを返す場合は以下のように指定されます。
Content-Type: text/html
2.2 Content-Length
レスポンスボディのサイズをバイト数で示すヘッダです。クライアントはこの値をもとに、データの受信が完了したかどうかを判断できます。
Content-Length: 128
この例では、レスポンスボディのデータサイズが128バイトであることを示しています。
2.3 Cache-Control
コンテンツのキャッシュ方針を指定するヘッダです。たとえばmax-age=3600と指定されている場合、クライアントは3600秒(1時間)の間、同じリソースに対する再リクエストを行わずにキャッシュされたデータを使用できます。
Cache-Control: max-age=3600
この例では、クライアントに対して「このレスポンスを3600秒(1時間)キャッシュしてよい」と指示しています。キャッシュが有効な間は、同じリソースへのリクエストをサーバに送信せずにキャッシュされたデータを利用できるため、通信量を削減できます。
2.4 Server
レスポンスを送信しているサーバソフトウェアの種類を示すヘッダです。
Server: uvicorn
この例では、PythonのASGIサーバであるuvicornが使用されていることがわかります。
このセクションで紹介したヘッダの一覧をまとめると以下のとおりです。
| ヘッダ | 種類 | 説明 |
|---|---|---|
Content-Type |
リクエスト / レスポンス | ボディのデータ形式を指定する(application/jsonなど) |
Authorization |
リクエスト | 認証情報(トークン)を格納する |
User-Agent |
リクエスト | クライアントの情報(ブラウザの種類など)を格納する |
Accept |
リクエスト | クライアントが期待するレスポンスのデータ形式を指定する |
Content-Length |
レスポンス | レスポンスボディのサイズをバイト数で示す |
Cache-Control |
レスポンス | コンテンツのキャッシュ方針を指定する |
Server |
レスポンス | サーバソフトウェアの種類を示す |