Zenn
🐷

Python Requests: 2025年のJSONデータのPOST送信方法

2024/11/26に公開
JavaScript
Python
API
JSON
tech

この包括的なガイドでは、PythonのRequestsライブラリを使用して、JSONデータをPOSTリクエストとして送信する方法を学びます。ステップバイステップの指示と実用的な例を通じて、効率的で効果的なAPI呼び出しを行えるようになります。さあ、Pythonのスキルを向上させましょう！

Python Requestsの紹介

Python Requestsは、PythonでHTTPリクエストを送信するための使いやすいライブラリです。GET、POST、PUT、DELETEなど、すべてのHTTPメソッドをサポートしており、Python 3.7以降では、ウェブサービスとのやりとりを簡素化します。

image.png

POSTリクエストを送信する

以下は、Python Requestsを使用してPOSTリクエストを送信する簡単な例です：

import requests

url = 'https://www.example.com/api'
data = {'username': 'my_username', 'password': 'my_password'}
response = requests.post(url, data=data)

print(response.status_code)
print(response.text)

この例では、https://www.example.com/apiにユーザー名とパスワードを含むペイロードでHTTP POSTリクエストを送信しています。レスポンスのステータスコードと内容はコンソールに表示されます。

Requestsライブラリのインストール

Python Requestsをインストールするには、以下のコマンドを使用します：

pip install requests

JSONの理解 📊

JSON（JavaScript Object Notation）は、軽量なデータ交換フォーマットで、人間が読み書きしやすく、機械が解析・生成しやすいです。JSONは言語に依存せず、ウェブアプリケーションでデータ交換のために広く使用されています。

json.png

JSONオブジェクトの例

{
  "id": 1001,
  "title": "What is JSON?",
  "author": {
    "id": 1,
    "name": "John Doe"
  },
  "tags": ["api", "json", "programming"],
  "published": false,
  "publishedTimestamp": null
}

このJSONオブジェクトは、文字列、数値、ブール値、null、配列、ネストされたオブジェクトなど、さまざまなデータ型を示すシンプルなブログ投稿を表しています。

POSTリクエストでJSONデータを送信する

次に、POSTリクエストでJSONデータを送信する方法を見てみましょう：

import requests
import json

url = 'https://www.example.com/api'
data = {'username': 'my_username', 'password': 'my_password'}
headers = {'Content-type': 'application/json'}

response = requests.post(url, data=json.dumps(data), headers=headers)

print(response.status_code)
print(response.text)

この例では、data辞書をjson.dumps()でJSON文字列に変換し、リクエストヘッダーにContent-type: application/jsonを含めています。

簡素化されたJSON POST

Python Requestsでは、jsonパラメータを使用して直接JSONデータを送信することもできます：

import requests

url = 'https://www.example.com/api'
data = {'username': 'my_username', 'password': 'my_password'}

response = requests.post(url, json=data)

print(response.status_code)
print(response.text)

この方法では、json.dumps()が不要で、コードが簡素化されます。

レスポンスの処理

POSTリクエストを送信した後、レスポンスを次のように処理します：

import requests

url = 'https://www.example.com/api'
data = {'username': 'my_username', 'password': 'my_password'}

response = requests.post(url, json=data)

if response.status_code == 200:
    print('成功！')
    print(response.json())  # レスポンスがJSONデータの場合
else:
    print('エラーが発生しました:', response.status_code)

レスポンスのステータスコードをチェックして、リクエストが成功したかどうかを確認します（通常、200が成功を示します）。

エラーを適切に処理する

HTTPリクエスト中にエラーが発生した場合、try-exceptブロックを使用して処理します：

import requests

url = 'https://www.example.com/api'
data = {'username': 'my_username', 'password': 'my_password'}

try:
    response = requests.post(url, json=data)
    response.raise_for_status()
except requests.exceptions.HTTPError as err:
    print('HTTPエラーが発生しました:', err)
except Exception as err:
    print('エラーが発生しました:', err)

このアプローチにより、プログラムが予期しない問題を適切に処理できます。

EchoAPIを使用してPythonでPOSTリクエストを送信する方法

echoapi4.jpg

EchoAPIは、APIテストと継続的な監視を効率化するための高度なAPIデバッグツールです。EchoAPIをワークフローに統合することで、パフォーマンステストを自動化し、開発プロセスの初期段階で潜在的な問題を検出できます。ここでは、EchoAPIを使用してPython POSTリクエストでJSONデータをシームレスに送信する方法を紹介します。

EchoAPIでPOSTリクエストを使用する手順

ステップ1: 新しいHTTPリクエストを作成する

  1. EchoAPIを開きます。
  2. 「新しいHTTP」ボタンをクリックして新しいリクエストを作成します。

img_v3_02f3_4c31904a-c1ef-467c-ae14-9a5b2292031g.jpg

ステップ2: HTTPメソッドを選択する

  1. 適切なリクエストメソッドを選択します。このチュートリアルではPOSTを選択します。

img_v3_02f3_6fcf977c-d8c2-42fd-9ba8-4e9a58b26d5g.jpg

ステップ3: リクエストボディを設定する

  1. リクエストの「Body」セクションに移動します。

  2. 利用可能な形式から「raw」を選択します。

  3. ドロップダウンメニューから「json」を選択します。

  4. 提供されたテキストエリアにJSONデータを入力します。以下の例をご覧ください：

    {
    "username": "my_username",
    "password": "my_password"
}

img_v3_02f3_b3930050-6307-44c3-8c3d-62a1dff0983g.jpg

ステップ4: リクエストを送信し、結果を確認する

  1. 「送信」ボタンをクリックしてリクエストを

送信します。
2. リクエスト結果（レスポンス）を確認します。

まとめ

Python Requestsライブラリは、JSONデータを送信するための強力で柔軟なツールです。この記事では、POSTリクエストを作成し、データを送信する方法を学びました。また、EchoAPIを使用してAPI呼び出しのデバッグとパフォーマンスチェックを効率化する方法も紹介しました。

PythonでAPIとのやりとりを行う際には、Requestsを活用し、JSON形式で効率的にデータをやりとりしましょう。

https://www.echoapi.com/?utm_source=6715bd30

Discussion