Pythonのrequests
ライブラリを使用してWeb APIと通信する際、HTTPステータスコードを確認して適切な例外処理を行う方法について解説します。
HTTPステータスコードとは
HTTPステータスコードは、Webサーバーからのレスポンスが正常であるか、何らかのエラーが発生したかを示すコードです。主なステータスコードの分類は以下の通りです。
- 100番台:処理中
- 200番台:成功
- 300番台:リダイレクト
- 400番台:クライアントエラー
- 500番台:サーバーエラー
raise_for_status()メソッド
requests
ライブラリのResponse
オブジェクトには、raise_for_status()
というメソッドがあります。このメソッドは、HTTPステータスコードが200番台かどうかを確認し、200番台以外であれば例外を発生させます。
try:
response = requests.get("https://***********")
response.raise_for_status()
except requests.exceptions.RequestException as e:
print("エラー : ", e)
上記のコードでは、外部サーバーにGETリクエストを送信し、レスポンスのステータスコードをraise_for_status()
メソッドで確認しています。ステータスコードが200番台であればtry:
ブロックの処理が実行され、200番台以外であればexcept:
ブロックが実行されます。
まとめ
Pythonのrequests
ライブラリを使用してWeb APIと通信する際、HTTPステータスコードを確認し、適切な例外処理を行うことが重要です。raise_for_status()
メソッドを活用することで、簡単にこの処理を実装することができます。