PythonのrequestsライブラリでAPIを呼び出す方法

Pythonでrequestsライブラリは、APIを扱うためによく使われています。それでは、Pythonのrequestsを使って、APIを呼び出すためには、どうしたらいいですか？本文では、Pythonのrequestsの使い方を皆さんに紹介します。Pythonのrequestsを使ってAPIとのやり取りをしたい方は、ぜひ本文の内容を参照してください。

また、Pythonのrequestsライブラリの代わりに、より直感的で使いやすいGUIのAPI管理ツールのApidogを使って、APIを呼び出して便利に管理することも可能なので、この使い方も一緒に皆さんに紹介していきたいと思います。

Pythonのrequestsとは？

Pythonのrequestsは、HTTPリクエストを送信するための非常に人気のあるライブラリです。requestsを使用することで、PythonプログラムがウェブページやAPIエンドポイントなどのリモートサーバーに対してGET、POST、PUT、DELETEなどのHTTPメソッドを使用してリクエストを送信し、レスポンスを受信することができます。

requestsライブラリは、Pythonの標準ライブラリであるurllibよりも使いやすく、シンプルなAPIを提供しています。このため、多くの開発者がHTTP通信を行う際にrequestsを選択します。

こちらもお読みください：urllibとrequestsモジュールとの比較

Pythonのrequestsの使用例

以下は、requestsを使用してGETリクエストを送信し、レスポンスを受け取る例です。

import requests

# GETリクエストを送信し、レスポンスを取得する
response = requests.get('https://api.example.com/data')

# レスポンスのステータスコードを確認する
print(response.status_code)

# レスポンスの内容をテキストとして表示する
print(response.text)

この例では、requests.get()関数を使用して指定したURLにGETリクエストを送信し、その結果をresponse変数に格納しています。その後、response.status_codeを使ってHTTPステータスコードを表示し、response.textを使ってレスポンスのテキスト内容を表示しています。

requestsライブラリには、他にもさまざまな機能があります。例えば、HTTPヘッダーの設定、クエリパラメータの追加、フォームデータの送信、JSONデータの送信などが可能です。そのため、requestsはPythonでのHTTP通信を行う際に非常に便利なツールとして広く利用されています。それでは、次は、requestsライブラリを使用して、APIを呼び出す方法の詳細を皆さんに紹介します。

使い方：Pythonのrequestsを使用してAPIを呼び出す方法

それでは、この部分では、機能が優れていてより使いやすいrequestsモジュールを使って、PythonでAPIを扱う方法を皆さんに紹介します。

requestsモジュールをインストール

Requestsモジュールの利用を開始するには、まずはこのモジュールをインストールする必要があります。次のコマンドを実行することで、当該モジュールをインストールできます。

pip install requests

requestsの機能を理解

Pythonのrequestsライブラリには、さまざまな機能を利用することができます。これらの機能を利用するために、異なるオプションで指定する必要があります。

requestsモジュールをインポート

Requestsモジュールをインストールすると、Requestsライブラリを利用するにはそれをインポートします。

import requests

APIのエンドポイントを指定

urlフィールドを用いて、APIのエンドポイントを指定します。

url = 'https://api.example.com/data'

必要なパラメータを辞書で指定

paramsを用いて必須のパラメータを指定します。

params = {'key1': 'value1', 'key2': 'value2'} 

リクエストを送信

response = requests.get(url, params=params)

レスポンスのステータスコードを確認

レスポンスのステータスコードを定義します。例えば次のコードは、ステータスコードが200の場合は、成功をプリントします。

if response.status_code == 200:
   print('Success!') 

レスポンスJSONをパース

レスポンスの形式をJSONに指定して、返せるように設定します。

data = response.json()
print(data)

完全の実行コードの例

ということで、上記のように、Pythonのrequestsで利用可能な各コンポーネントやオプションを理解した上、次の例のように、各オプションを組み合わせて、完全なAPI呼び出しコードを実行すれば、APIとの通信を実現することができます。

requestsモジュールを使ってAPIにアクセスする完全な実行コードの例：

import requests
import json

# APIのエンドポイント
URL = "https://api.example.com/v1/users"  

# パラメータ
PARAMS = {'key':'abcd1234'}  

# リクエストを送信 
res = requests.get(url = URL, params = PARAMS)

# ステータスコード確認
if res.status_code == 200:
  print('Success!')
else:
  print('Failed. status code: '+ str(res.status_code))

# JSONレスポンスを取得  
data = json.loads(res.text)

print(data)

# 個別の値を参照
print("User Count:", data['count']) 
print("First User ID:", data['users'][0]['id'])

以上のような手順で、Pythonとrequestsモジュールを使ってAPIのGETリクエストを簡単に扱うことができます。また、認証やPOSTリクエストなども同様のインターフェースで処理できます。

より便利にAPIをテストできるApidog

Pythonのrequestsを使ってAPIを扱うためにも、コーディング能力が必要となります。実際には、Apidogなどの適切なツールを使用すると、ノーコードでもAPIを簡単にテストすることができます。そして、リクエストの情報を保存して、APIドキュメントを生成することもできるので、非常に便利です。

ステップ⒈Apidogを開き、「新しいAPI」、またh「新しいRequest」をクリックします。

ステップ⒉APIが使用するHTTPメソッドを選択した上、エンドポイントのURLを入力します。

ステップ⒊必要なパラメータなどの情報を記入して送信ボタンをクリックして、APIのリクエストを送信して、レスポンスを取得します。

以上の手順を参照して、APIを簡単にテストすることができます。また、「保存」ボタンをクリックして、今回のリクエストの情報を保存して、ドキュメントを生成することもできるので、非常に便利です。

Pythonのrequestsの実装コードも生成

また、上記の手順を参照して、リクエストの情報を保存すると、Pythonのrequestsの実装コードが必要となる場合は、Apidogを使って、1クリックでそれを生成することができるので、実装コードを手動で記述しなくても、簡単に取得できます。

ステップ⒈Apidogで先に保存したAPIかRequestを選択して、右側パネルで「コード生成」にガーソルを置き、「クライアントコードを生成」を選択します。

ステップ⒉コード生成ウィンドウで、「Python」を選択し、「Requests」を選択すると、Requestsモジュールの実装コードを生成することができます。

まとめ

この記事は、Pythonのrequestsライブラリを使ってAPIを呼び出す方法とともに、GUIベースのAPIテストツールであるApidogの利用方法についても詳しく解説しています。requestsライブラリを使うとコードベースでAPIを呼び出せますが、Apidogを使えばコーディング不要でAPIのテストができます。Apidog上でHTTPメソッド、エンドポイント、パラメータ等を設定することで、簡単にAPIリクエストを送信し、レスポンスを確認できます。

また、Apidogにはリクエストの保存機能があり、これを利用することでAPIドキュメントの生成も可能です。保存したリクエスト情報から、Pythonのrequestsライブラリによる実装コードも1クリックで生成できるのが大きな特徴です。

つまり、Apidogを活用することで、コーディング不要でのAPIテストが実現でき、ドキュメント作成やコード生成も便利に行えます。Python開発者がAPIを扱う際には、requestsライブラリと合わせてApidogも同時に使いこなすことが大切だ言えるのでしょう。