Python リクエスト - ヘッダーと本文を含む POST リクエスト

Python のリクエスト ライブラリは、シンプルかつ効率的な方法で HTTP リクエストを作成するための強力なツールです。 GET、POST、その他の種類のリクエストを Web サーバーに送信するための使いやすいインターフェイスを提供します。 POST リクエストを作成するときは、通常、サーバーが処理する追加情報とデータを含むヘッダーとリクエスト本文を含めます。

この記事では、リクエスト ライブラリを使用してヘッダーと本文を含む POST リクエストを作成する方法を説明します。ヘッダーとリクエスト本文の基本概念を紹介し、requests.post() メソッドでの使用法を示し、応答とエラーを処理するためのベスト プラクティスについて説明します。

環境のセットアップ

Python のリクエスト ライブラリを使用してヘッダーとリクエスト本文を含む POST リクエストを作成する前に、環境が正しく設定されていることを確認してください。従うべき手順は次のとおりです -

リクエストライブラリのインストール

• Python 3 以降を使用している場合、リクエスト ライブラリは標準ライブラリにバンドルされていないため、別途インストールする必要があります。ターミナルまたはコマンド プロンプトを開き、次のコマンドを実行します:

リーリー

• 統合ターミナルを備えた IDE またはコード エディターを使用している場合は、エディター内のターミナル パネルからライブラリを直接インストールできます。

リクエストモジュールのインポート

ライブラリをインストールした後、必ず Python スクリプトの先頭または対話型 Python 環境にリクエスト モジュールをインポートしてください。 リーリー

リクエスト ライブラリをインストールしてインポートすると、ヘッダーとリクエスト本文を使用して POST リクエストを作成できるようになります。

次のセクションでは、ヘッダーとリクエスト本文を構築する方法を検討し、次に、requests.post() メソッドを使用して実際の POST リクエストを作成する方法に進みます。

ヘッダーとリクエスト本文の構築

ヘッダーとリクエスト本文を含む POST リクエストを作成するには、requests.post() メソッドを使用してリクエストを送信する前にヘッダーと本文を構築する必要があります。プロセスを段階的に見てみましょう:

構築ヘッダー

• ヘッダーは、認証資格情報、コンテンツ タイプ、ユーザー エージェントなど、リクエストに関する追加情報を提供します。ヘッダーを request.post() メソッドの headers パラメーターに辞書として渡すことで、POST リクエストにヘッダーを含めることができます。

• ヘッダーを構築するには、目的のヘッダー名をキーとして、対応する値を値として含む辞書を作成します。以下に例を示します -

リーリー

• 「application/json」をリクエストに適したコンテンツ タイプに置き換え、「your_token_here」を実際の認可トークン (必要な場合) に置き換えます。

リクエスト本文の構築

• リクエスト本文には、POST リクエストの一部として送信するデータが含まれています。 JSON、フォームデータ、プレーンテキストなど、さまざまな形式にすることができます。形式の選択は、サーバーの期待によって異なります。

• リクエスト本文を構築するには、必要なデータを含むディクショナリまたはデータ構造を作成します。 JSON 形式を使用した例を次に示します -

リーリー

• この例では、サンプル データを使用して辞書ペイロードを作成します。次に、 json.dumps() を使用して辞書を JSON 文字列表現に変換します。これは、リクエスト本文で JSON データを送信するために必要です。

次のセクションでは、構築されたヘッダーとリクエスト本文をまとめて、requests.post() メソッドを使用して実際の POST リクエストを作成します。

POSTリクエストの発行

ヘッダーとリクエスト本文を構築したので、requests.post() メソッドを使用して実際の POST リクエストの作成に進むことができます。操作方法は以下の通りです。

URLを指定してください

最初に、POST リクエストの送信先となる URL を指定します。以下のスニペットの「https://api.example.com/endpoint」を実際の URL に置き換えます。

• リーリー
POSTリクエストの発行

requests.post() メソッドを使用して POST リクエストを送信します。 URL、ヘッダー、リクエスト本文をパラメータとして渡します。

• リーリー
応答を処理中

requests.post() メソッドは、リクエストに対するサーバーの応答を含む Response オブジェクトを返します。
Response オブジェクトのさまざまなプロパティとメソッドを使用して、応答ステータス コード、応答ヘッダー、および応答本文にアクセスできます。以下に例を示します:

• リーリー ＃＃＃エラー処理＃＃＃

リクエスト中に発生する可能性のある潜在的なエラーに対処することが重要です。リクエストが失敗した場合 (ステータス コード >= 400)、response.raise_for_status() を使用して例外を発生させることができます。

• リーリー

  以下の手順に従うことで、Python のリクエスト ライブラリを使用して、ヘッダーとリクエスト本文を含む POST リクエストを効率的に作成できます。

  带有标头和正文的 POST 请求

  为了演示如何使用请求来发出带有标头和正文的 POST 请求，让我们考虑一个将 JSON 负载发送到 API 端点的示例。这是完整的代码−

  示例

  import requests
  import json
  
  # Set up the URL
  url = 'https://api.example.com/endpoint'
  
  # Set up the headers
  headers = {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer your_token'
  }
  
  # Set up the request body
  payload = {
      'name': 'John Doe',
      'email': 'johndoe@example.com',
      'age': 30
  }
  json_payload = json.dumps(payload)
  
  # Make the POST request
  response = requests.post(url, headers=headers, data=json_payload)
  
  # Check the response
  if response.status_code == 200:
      print('Request successful!')
      print(response.json())
  else:
      print('Request failed!')
      print(response.text)
  

  让我们分解一下代码−

  • 我们导入必要的模块− 请求用于发出 HTTP 请求和 json 用于处理 JSON 数据

  • 我们设置要将 POST 请求发送到的 URL。

  • 我们定义标头，包括指定我们发送 JSON 数据的“Content-Type”标头以及“Authorization”标头（如果 API 需要）。

  • 我们将请求正文设置为 Python 字典，然后使用 json.dumps() 将其转换为 JSON 字符串。

  • 我们使用 requests.post() 发出 POST 请求，并将 URL、标头和请求正文作为参数传递。

  • 我们检查响应状态代码。如果是 200（表示请求成功），我们将打印响应 JSON。否则，我们将打印响应文本以识别任何错误。

  此示例演示如何使用 Python 中的请求库发出带有标头和请求正文的 POST 请求。请随意根据您的具体要求自定义代码。

  结论

  在本文中，我们探讨了如何使用 Python 中的 requests 库发出带有标头和请求正文的 POST 请求。通过安装 requests 库并了解其依赖关系，我们了解了设置环境的重要性。

  在本文中，我们探讨了如何使用 Python 中的 requests 库发出带有标头和请求正文的 POST 请求。通过安装 requests 库并了解其依赖关系，我们了解了设置环境的重要性。

  然后，我们运行了一个完整的示例，演示了发送 JSON 有效负载作为请求正文并在请求中包含标头的过程。我们逐步浏览了代码并详细讨论了每个组件。

以上がPython リクエスト - ヘッダーと本文を含む POST リクエストの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。