Pythonで湧き水APIを触ってみる＋LambdaでAPIを自作してみる

Last updated at 2024-09-30Posted at 2024-09-30

はじめに

インターネット上でデータをやり取りする際、APIは非常に便利なツールです。
APIを利用することで、さまざまなデータにアクセスしたり、サービスを実行したりすることができます。
しかし、「APIを自分で使うにはどうすればいいの？」と疑問を持つ方も多いかもしれません。

本記事では、APIの基本的な概念から始め、自分でAPIを実行し、その応答を確認する方法を紹介します。

前半でAPIとは何かを説明した上で、Pythonを使って実際にAPIを呼び出し、データを取得する体験をしてみましょう。
そして後半では、AWS Lambdaを使用して自分で関数(API)を作成しLambda上でのテストとVScodeを使用してPythonで自作API呼び出しまでを行います。

この記事は以下のような人におすすめです。

APIを実行する方法が知りたい
AWS Lambdaを使用した関数作成の方法が知りたい

記事の構成

【前半】
APIとは何か？というところから湧き水APIを呼び出して応答を確認するところまでを行います。

APIって何？
湧き水APIとは？
APIの取得方法
湧き水APIをPythonで実行してみる

【後半】
前半でAPIを使用した体験を元に、今度は自作APIを作成し、Pythonで実行するところまでを行います。
API作成にはAWS Lambdaを使用します。

AWS Lambdaとは？
Lambdaで関数を作成
デフォルトのコードを書き換える
テストコードを実行する
関数URLから応答を確認する
自作APIをPythonで実行してみる

【前半】Pythonで湧き水APIを実行してみる

使用環境

OS：Windows 11
Pythonバージョン：3.12.6
使用ライブラリ：requests、dotenv

インストールされていないライブラリがある場合は下記コマンドを実行しインストールを行なってください。

pip install requests
pip install python-dotenv

APIとは？

APIとは「Application Programming Interface」の略で、ソフトウェアやサービス間でデータやコマンドをやり取りするための仕組みです。

APIは、異なるプログラムやサービス間の通訳や橋渡しの役割を果たします。
特定のルール（プロトコル）に従ってリクエストを送り、必要なデータを受け取ります。

開発者はこの仕組みを利用することで、一から複雑な機能を作る必要がなく、既存のサービスの機能を自分のアプリに組み込むことができます。
無料のものから有料のものまで様々なAPIが公開されています。

湧き水APIとは？

下記サイトで公開されている「湧き水検索」というAPIのことで、
全国の湧き水の場所をJSON形式で返してくれます。

湧き水APIの取得方法

旅々APIに載っているAPIを使用するためにはリブログアカウントの登録が必要なので、下記サイトからアカウントの新規登録を行います。

ログインしたら、画像のAPIページにアクセスします。

トークンを生成をクリックし、APIトークンを発行します。

APIトークンの取り扱いについて
絶対に他の人にトークンが漏れないように管理してください。
流出すると、APIが不正利用されてしまいます。

実際にPythonで実行してみる

まず、湧き水検索の一覧取得をクリックしてGETの部分をコピーします。

次にこのコードをPythonに変換します。
生成AIに「これをPythonで実行できるようにして」とコードと一緒に質問を投げます。

今回は以下のコードが生成されました。
愛知県に絞って湧き水の場所を標示してくれます。

wakimizu.py

import os
import requests
import json
from dotenv import load_dotenv

# .envファイルから環境変数を読み込む
load_dotenv()

# APIのURL
url = "https://app.livlog.xyz/webapi/v2/spring-water/list"

# パラメータの設定
params = {
    "pref": "愛知県"  # エンコード済みのパラメータ
}

# 環境変数からトークンを取得
api_token = os.getenv("API_TOKEN")

# ヘッダーの設定
headers = {
    "Accept": "application/json",
    "Authorization": f"Bearer {api_token}"  # トークンが必要な場合
}

try:
    # APIリクエストの送信
    response = requests.get(url, params=params, headers=headers)

    # ステータスコードの確認
    if response.status_code == 200:
        # JSONデータの取得
        data = response.json()
        
        # 結果の表示
        print(json.dumps(data, indent=2, ensure_ascii=False))
    else:
        print(f"エラー: ステータスコード {response.status_code}")
        print(response.text)

except requests.exceptions.RequestException as e:
    print(f"リクエストエラー: {e}")

コードの中で環境変数からトークンを取得してくる部分があります。

wakimizu.py

# 環境変数からトークンを取得
api_token = os.getenv("API_TOKEN")

今回は同じフォルダ内に .env というファイルを作成してトークンを取得できるようにしましょう。

.envファイルとは、データベースのパスワードやAPIキーなど、アプリケーションの動作に必要な秘密の情報を含んでいるファイルです。
このファイルを使うことで、環境変数をまとめて管理できるようになります。

通常、環境変数はOSに設定する必要がありますが、.envファイルを使えば、OSの設定に頼らず、アプリケーションが起動時にこのファイルから必要な変数を読み込んで使用できます。

今回はwakimizu.pyで、API_TOKENの値を取得すると表記されているので、 .envは以下のような内容にします。

.env

API_TOKEN = 生成したAPIトークン

GitHubに上げる際の注意点
.envのように誰にも見られたくないファイルをgitに上げる際は
.gitignoreでファイルを無視する設定を行うようにしてください。

これでAPIを呼び出す準備が整ったので、実行すると…

無事Pythonで湧き水の情報を表示できました！

今回は愛知県でしたが、千葉県の湧き水を指定することもできます。

wakimizu.py

# パラメータの設定
params = {
    "pref": "愛知県"  # エンコード済みのパラメータ
    #ここを千葉県に変える
}

千葉県の湧き水の場所を表示することができました！

【後半】AWS LambdaでAPIを自作してみる

それでは、今度はAPIを自作してみましょう。
今回はAWS Lambdaを使用します。

AWS Lambdaとは？

プログラムを書いて動かすためにサーバーを管理する必要がなく、コードを書けば自動的に実行してくれるAWSサービスです。
たとえば、何かイベント（データがアップロードされたり、ボタンがクリックされたり）が発生したときに、そのイベントに反応してプログラム（Lambda関数）が実行されます。

Lambdaで関数を作成

まず、AWSコンソールにログインしLambdaの関数ページに移動します。

関数の作成をクリックし、画像の通り設定を行います。

ランタイム：Python 3.12
アーキテクチャ：arm64

設定ができたら下にスクロールして作成します。

これで関数が作成できました。

デフォルトのコードを書き換えてみる

コードはデフォルトだと、Hello from Lambda!を返してくれるだけの内容になっています。

Lambdaの部分をクエリパラメータから取得した名前になるように変えてみます。

practice_my_api


import json

def lambda_handler(event, context):
    # クエリパラメータから名前を取得
    name = event.get('queryStringParameters', {}).get('name', 'Lambda')
    
    # レスポンスメッセージを作成
    message = f'Hello from {name}!'
    
    # レスポンスを返す
    return {
        'statusCode': 200,
        'body': json.dumps(message)
    }

テストを作成して、応答をテストする

テストコードを用いて挙動を確認することが出来ます。

テストタブに移動し、新しいイベントを作成からテストを新規作成します。
今回、名前はtestにして何も変更せず保存します。

変更を行っていない状態でテストを行い返答を確認してみます。
このコードではnameを指定していないので、Hello from Lambda!が返ってきました。

テストコードを以下の内容に書き換えます。
クエリパラメータのnameをJohnにするという内容です。

test

{
  "queryStringParameters": {
    "name": "John"
  }
}

保存したあとに、テストをクリックします。
詳細▶を開くと、テスト結果が表示されて、応答がJohnに代わっていることを確認できました。

関数URLから応答を確認する

関数URLから応答を確認します。
まず、設定タブに移動し、関数URLをクリックします。

今回は後ほどPythonで実行するため、認証タイプを NONE にします。
これで世界にAPIを公開することが出来ます。

APIの公開範囲について
APIのセキュリティや用途によって選択してください。

AWS_IAM
APIを使える人やシステムをIAMユーザーやロールで制限できます。
つまり、AWSアカウントに登録されているユーザーやサービスだけがAPIにアクセスできるようになります。
NONE
特別なアクセス制限をかけない設定で、APIに誰でもアクセスできる状態になります。
APIがインターネット上に公開されていて、アクセスするために特別な認証は必要とされません。

これで関数URLを作成できました。
クリックしてアクセスしてみます。

応答が返ってきました。
nameのクエリパラメータをこちらで指定していない為、Lambdaのままになっています。

URLを変更してnameに任意の名前を入れてみます。
awsの末尾に　?name=(任意の名前)　を追加します
今回はKCと入れます。

URLを更新すると"Hello from KC!"と表示されました。

自作APIをPythonで実行してみる

最後に湧き水APIのように自作APIを呼び出してみましょう。

下記のコードを使用します。
nameと定義した変数に値を入れると、nameのクエリパラメータがその値に変更されて表示されます。
今回は、nameをnaitoとします。

hello_lambda.py

import requests

def get_response(name):
        url = f"[自分の関数URL]/?name={name}"
    
    try:
        response = requests.get(url)
        response.raise_for_status()  # エラーがあれば例外を発生させる
        return response.json()
    except requests.RequestException as e:
        return f"エラーが発生しました: {e}"

# 使用例
name = "naito"
result = get_response(name)
print(result)

Hello from naito!と返ってきたので、関数の実行は成功です！

まとめ

本記事ではAPIを使う、作るといったことを行いました。

サーバーレス環境であるLambdaを使うことで、簡単に関数を作成し、呼び出すことができました。
今回はシンプルな関数を作成して呼び出しただけなので、スケーリング機能は活用していませんが、その手軽さがとても印象的でした。

また、今回は「自作して自分で実行してみる」という部分に重点を置いたため、Lambdaの設定は最小限に留めています。
実際に運用する際には、認証やアクセス制限などセキュリティ面の設定を十分に行うことを推奨いたします。

少しでもこの記事が参考になりましたら幸いです。
読んでいただきありがとうございました！

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up