【Python】requestsでAPIにGET/POST送信する方法(入門)

# 1. 仮想環境の作成と有効化(任意)
python -m venv .venv
# Windows
.\.venv\Scripts\activate
# macOS/Linux
source .venv/bin/activate

# 2. requestsのインストール
pip install -U requests

# 3. バージョンの確認
python -c "import requests; print(requests.__version__)"

# 最小のGETリクエストの例
# httpbinはテスト用の公開APIです。送った内容をそのまま返してくれます。
import json
import requests

url = "https://httpbin.org/get"
resp = requests.get(url)  # URLだけで送信

print("status:", resp.status_code)
# JSONとして受け取り、重要な一部だけ整形して表示
data = resp.json()
print(json.dumps({"url": data["url"], "args": data["args"]}, ensure_ascii=False, indent=2))

{
  "status": 200,
  "url": "https://httpbin.org/get",
  "args": {}
}

# クエリパラメータ付きGET
import requests

url = "https://httpbin.org/get"
params = {"q": "python", "page": 1}
resp = requests.get(url, params=params)

print("final url:", resp.url)  # エンコード後の最終URL
print("args:", resp.json()["args"])  # サーバーが受け取ったクエリ

# ヘッダーを付与して送信
import requests

url = "https://httpbin.org/headers"
headers = {
    "User-Agent": "my-sample-app/0.1",
    "Accept": "application/json",
    "X-Request-Source": "tutorial"
}
resp = requests.get(url, headers=headers)
data = resp.json()

# サーバーが受け取ったヘッダーの一部を確認
received = {
    "User-Agent": data["headers"].get("User-Agent"),
    "Accept": data["headers"].get("Accept"),
    "X-Request-Source": data["headers"].get("X-Request-Source"),
}
print(received)

# JSONの取得とパース
import requests

resp = requests.get("https://httpbin.org/json")  # 固定のJSONを返すエンドポイント
try:
    data = resp.json()  # JSON以外なら例外が発生
    print("title:", data.get("slideshow", {}).get("title"))
except ValueError as e:
    print("JSONとして読み取れませんでした:", e)

# ステータスコードの確認と基本的な分岐
import requests

resp = requests.get("https://httpbin.org/status/404")
print("status:", resp.status_code, "ok:", resp.ok)

if resp.ok:
    print("成功:", resp.text[:60])
else:
    print("失敗:", resp.status_code)

# エラーの基本パターン
import requests

try:
    # わざと短いタイムアウトで遅延エンドポイントにアクセスしてTimeoutを誘発
    resp = requests.get("https://httpbin.org/delay/3", timeout=0.5)
    resp.raise_for_status()  # 4xx/5xxはHTTPErrorに
    print("成功:", resp.status_code)
except requests.exceptions.Timeout:
    print("タイムアウトしました")
except requests.exceptions.HTTPError as e:
    print("HTTPエラー:", e, "status:", getattr(e.response, "status_code", "?"))
except requests.exceptions.RequestException as e:
    # 上記以外のrequests由来のエラーはこれで捕捉
    print("通信エラー:", e)

# JSONをPOSTで送る
import requests

url = "https://httpbin.org/post"
payload = {"name": "Taro", "age": 20}
resp = requests.post(url, json=payload)  # json= でOK
data = resp.json()

# サーバーが受け取ったJSONを確認
print("received json:", data["json"])

# フォームデータの送信
import requests

url = "https://httpbin.org/post"
form = {"username": "alice", "password": "secret"}
resp = requests.post(url, data=form)
print("received form:", resp.json()["form"])

# ファイルアップロードの例(メモリ上で擬似ファイルを作成)
import io
import requests

url = "https://httpbin.org/post"
files = {
    # ("ファイル名", ファイルオブジェクト, "MIMEタイプ")
    "file": ("hello.txt", io.BytesIO(b"Hello from requests!"), "text/plain")
}
resp = requests.post(url, files=files)
data = resp.json()

# サーバーが受け取ったファイルの内容を確認
print(data["files"]["file"])

# レスポンスのContent-Typeを見て読み方を分ける
import requests

resp = requests.post("https://httpbin.org/post", json={"ping": "pong"})
ctype = resp.headers.get("Content-Type", "")

if "application/json" in ctype:
    print("as json:", resp.json().get("json"))
else:
    print("as text:", resp.text[:120])

# 失敗時の基本対処
import logging
import requests

logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
url = "https://httpbin.org/status/400"  # 400を返す

try:
    resp = requests.post(url, json={"example": 1})
    resp.raise_for_status()
except requests.exceptions.HTTPError as e:
    # 問題の切り分けに役立つ情報だけ記録
    logging.error("HTTPError status=%s url=%s", e.response.status_code, e.response.url)

# タイムアウトの使い方
import requests

# 単一値は接続と読み取りの両方に適用
requests.get("https://httpbin.org/delay/2", timeout=3)

# タプルで(接続, 読み取り)を個別に設定
try:
    requests.get("https://httpbin.org/delay/2", timeout=(0.3, 0.3))
except requests.exceptions.Timeout:
    print("timeout!")

# APIキーを環境変数から読み、Authorizationヘッダーに設定
import os
import requests

API_KEY = os.getenv("MY_API_KEY")  # 事前に環境変数を設定しておく
if not API_KEY:
    raise RuntimeError("MY_API_KEY が設定されていません")

headers = {"Authorization": f"Bearer {API_KEY}"}

# 例: ダミーのエンドポイントを想定
# resp = requests.get("https://api.example.com/v1/me", headers=headers, timeout=5)
# print(resp.json())

print("ヘッダー例:", headers)

# ベースURLとSessionの活用
from urllib.parse import urljoin
import requests

BASE_URL = "https://httpbin.org/"

def build_url(path: str) -> str:
    # urljoinはスラッシュの重複や欠落に強い
    return urljoin(BASE_URL, path.lstrip("/"))

with requests.Session() as s:
    # 共通のヘッダーやタイムアウトを1箇所で設定
    s.headers.update({"User-Agent": "my-sample-app/0.1"})
    # 例: エンドポイントを順に呼び出す
    r1 = s.get(build_url("/get"), params={"q": "python"}, timeout=5)
    r2 = s.get(build_url("json"), timeout=5)
    print("r1:", r1.status_code, r1.url)
    print("r2:", r2.status_code, r2.url)

# 文字化け対策の基本パターン
import requests

resp = requests.get("https://httpbin.org/encoding/utf8")
# サーバーの宣言が怪しい場合は推定値を採用
if not resp.encoding or resp.encoding.lower() == "iso-8859-1":
    resp.encoding = resp.apparent_encoding

text = resp.text  # 適切なエンコーディングでデコードされた文字列
print(text.splitlines()[0])  # 先頭行だけ表示

# 安全なログ出力の例(トークンやクレデンシャルをマスク)
import logging
import re
import requests

logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")

SENSITIVE_HEADER_KEYS = {"authorization", "x-api-key", "proxy-authorization"}

def mask_headers(headers: dict) -> dict:
    masked = {}
    for k, v in headers.items():
        if k.lower() in SENSITIVE_HEADER_KEYS:
            masked[k] = "****"  # 全面マスク
        else:
            masked[k] = v
    return masked

def mask_body(body: str) -> str:
    if body is None:
        return ""
    # "password":"xxx" のようなパターンをマスク(簡易版)
    return re.sub(r'("password"\s*:\s*")([^"]+)(")', r'****', body)

url = "https://httpbin.org/post"
payload = {"username": "alice", "password": "secret"}

resp = requests.post(url, json=payload, headers={"Authorization": "Bearer TOKEN"})
safe_req_headers = mask_headers(resp.request.headers)
safe_req_body = mask_body(resp.request.body.decode() if isinstance(resp.request.body, bytes) else str(resp.request.body))

logging.info("request %s %s", resp.request.method, resp.request.url)
logging.info("headers %s", safe_req_headers)
logging.info("body %s", safe_req_body)
logging.info("response %s", resp.status_code)