HTTPリクエストのheadersに指定できる一般的なパラメータのメモ。
こんなのがあるんだ〜くらいのマインドです。
どこに書くのか
Pythonのrequestsライブラリを使用して外部APIにGETリクエストを送信する例です。
import requests
url = "https://example.com/api/endpoint"
# ↓ここ
headers = {
"Host": "example.com",
"User-Agent": "YourApp/1.0",
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
}
response = requests.get(url, headers=headers)
User-Agent
クライアントアプリケーションやブラウザなどのユーザーエージェントの情報を示すヘッダー。サーバーにクライアントの種類やバージョンなどを通知する。
"User-Agent": "YourApp/1.0"
「YourApp」はアプリケーション名で、「1.0」はアプリケーションのバージョン。
Authorization
認証情報を含むヘッダー。主にトークンやBasic認証などの認証情報を伝える。
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
例はトークンベースの認証で、Bearerはトークンタイプを示し、その後にアクセストークンが続く。
Content-Type
リクエストの本文(payload)のデータタイプを示すヘッダー。サーバーがリクエストを適切に処理するために使用される。
"Content-Type": "application/json"
HTTPリクエストやレスポンスの中身がJSON形式のデータであることを明示している。
Accept
クライアントが受け入れ可能なレスポンスのデータタイプを示すヘッダー。サーバーはこの情報をもとに適切なコンテンツを返す。
"Accept": "application/json"
クライアントがこのヘッダーを使用して、サーバーに対して「JSON形式のデータを希望しています」という情報を提供している。
Host
リクエストが送信される対象のホスト名を示すヘッダー。特に仮想ホスティング環境で重要。
"Host": "example.com"
ここで指定されている値(example.com)は、リクエストが送信される対象のホスト名(ドメイン名)を示している。これにより、サーバーはリクエストを正しいコンテンツやエンドポイントに割り当てて処理できるようになる。
Referer
リクエストが発生する前のURLを示すヘッダー。主にリンク元の情報をサーバーに提供する。
"Referer": "https://example.com"
ここで指定されている値(https://example.com) は、リクエストが発生する前のURLを示している。これによってサーバーサイドは、リクエストがどのページやリソースから発生したかを知ることができる。
Cookie
クライアントがサーバーに保存されたCookie情報を送るためのヘッダー。
"Cookie": "key=value"
クライアントがサーバーに対して key という名前のCookie情報を送信している。サーバーはこの情報を使用して、ユーザーのセッションを識別し、それに基づいてカスタマイズされた体験を提供することができる。
Cache-Control
キャッシュの制御を指示するヘッダー。キャッシュの動作を制御する指示を含むことがある。
"Cache-Control": "no-cache"
キャッシュを無効化し、必ずサーバーとの通信を行うことを指示している。