まとめ

Pythonを使ったAPI入門

Chris Ramakers

Engineering Manager

APIの基本

APIの役割
さまざまな種類のAPI
URLの構成要素
リクエストメッセージとレスポンスメッセージの構成
HTTPメソッド

PythonでAPIを扱う

requestsパッケージ

import requests

HTTPメソッド

# Read a resource
requests.get('https://api.my-music.com')
# Create a resource
requests.post('https://api.my-music.com', data={...})
# Update a resource
requests.put('https://api.my-music.com', data={...})
# Delete a resource
requests.delete('https://api.my-music.com')

URLパラメータ

query_params = {'artist': 'Deep Purple'}
requests.get('http://api.my-music.com', params=query_params)

ヘッダー

headers = {'accept': 'application/json'}
response = requests.get('http://api.my-music.com', headers=headers)
print(response.headers.get('content-type'))

ステータスコード

response = requests.get('http://api.my-music.com')
print(response.status_code)

発展的なトピック

認証

Basic認証

headers = {'Authorization':'Basic am9obkBleGF...'}

APIキー/トークン認証

headers = {'Authorization': 'Bearer faaa1c9f4...'}

構造化データ

JSON形式のデータをリクエストする

requests.get('https://api.my-music.com', headers={'accept': 'application/json'})

JSON形式のデータを送信する

playlists = [{"Name":"My favorite songs"}, {"Name":"Road Trip"}]
requests.post('https://api.my-music.com/playlists/', json=playlists)

エラー処理

エラーの種類
- 接続エラー
- HTTPエラー
  - 4XX クライアントエラー
  - 5XX サーバー側のエラー
ステータスコードによるエラー処理
- response.status_code
例外によるエラー処理
- raise_for_error()

import requests
from requests.exceptions import ConnectionError, HTTPError

try:
    response = requests.get("http://api.music-catalog.com/albums") 
    response.raise_for_status()

except ConnectionError as conn_err: 
    print(f'Connection Error! {conn_err}.')

except HTTPError as http_err:
    print(f'HTTP error occurred: {http_err}')

おめでとうございます！

Pythonを使ったAPI入門