「Pythonガイド」 APIからデータを簡単に取得！

Pythonは多くの開発者に利用されるプログラミング言語として、よくPython環境でAPIとのやり取りをする必要があります。それでは、Python APIからデータ取得をするために、どうしたらいいですか？本文では、PythonでAPIからデータを簡単に取得する詳細の方法を紹介しますので、初心者でも、このガイドを参照して、PythonでAPIからデータを取得できます。

PythonでAPIを処理するライブラリ

PythonでAPIを呼び出すために、汎用されるライブラリにはRequestsとurllibがありますね。urllibはPython標準ライブラリのモジュールとはいえ、requestsは使いやすさと機能面で優れているのでより広く利用されています。Python環境でAPIからデータを取得するために、PythonのRequestsライブラリを使用するのが便利です。

PythonのRequestsライブラリを利用してAPIからデータを取得するには、まずはRequestsライブラリをインストールする必要があります。次のコマンドを使用することで、当該ライブラリをインストールすることができます。

pip install requests

APIからデータ取得のために、Python Requestsを設定

Python Requestsライブラリをインストールすると、APIからデータを取得するために、いくつかの設定事項が必要があります。例えば、HTTPメソッド、APIのエンドポイントや必須のパラメータなどをAPI仕様書を参照して設定する必要があります。

APIデータ取得のメソッドを使用

Web APIやREST APIでは、データを取得するために、特定のHTTPメソッドを使用する必要があります。次はAPIでよく利用されるHTTPメソッド及びその関連の操作を紹介します。

• GET：APIからデータ取得
• POST：APIにデータを追加
• PUT：APIの既存データを更新
• DELETE：APIの既存データを削除

ということで、PythonでAPIからデータを取得するために、GETメソッドを利用する必要があります。PythonのRequestsライブラリを利用する場合は、requests.getという形で、HTTPメソッドをGET（データ取得）に指定することができます。

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でAPIからデータを取得する方法

それでは、PythonでAPIからデータを取得する方法を紹介します。Pythonのrequestsライブラリをパソコンにインストールすると、次の実装コードを利用して特定のAPIエンドポイントから特定のデータを取得することができます。

# requestsライブラリを利用
import requests

# jsonデータを利用
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'])

上記のサンプルコードでは、requestsライブラリをインポートして、GETリクエストを送信することができます。具体的な情報として、このサンプルコードでは以下のようなリクエストを送信しています。

• リクエスト先: https://api.example.com/v1/users
• メソッド: GET
• パラメータ: {'key':'abcd1234'}

これは架空のAPIサーバーに対して、ユーザーデータの取得を目的としたリクエストです。パラメータにAPIキーを指定することで、このAPIサービスからデータの取得が許可されるという設定になっています。

レスポンスとしては、ユーザーに関する以下のようなJSONデータが取得できることを想定しています。

• ユーザーの全数(countキー)
• ユーザーの詳細情報(usersキーの配列)
• ユーザーID(idキー)
• 名前、メールアドレスなど(その他不明な属性)

print文で個別データにアクセスしているのも、こうした JSONレスポンス構造を想定しているためです。つまり、このAPIサービスからはユーザー全体の概要と、個別ユーザーの属性が取得できるということになります。

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でAPIからデータを取得する基本的な方法について解説しました。requestsライブラリを使うことでコードはシンプルに書けますが、実際の開発現場ではAPIテスト・ドキュメント作成などの利便性が重要視されます。

その点、Apidogというツールを活用することで、GUIベースで手軽にAPIリクエストをテストでき、結果を保存してドキュメントを自動生成することも可能です。加えて、保存したリクエスト情報からPythonのrequestsコードも一発で生成できるので、開発効率が大きく向上します。

Webアプリケーションにおいて外部APIとの連携は必須である場合が多く、そうした開発現場でApidogは強力な武器となりえます。 GUIベースの操作性と自動ドキュメント生成など、Python初心者から熟練者まで幅広い層に大いに役立つツールだと言えるでしょう。