FastAPI 軽快なAPI構築 チュートリアル
FastAPI を使った軽量 API サーバー構築
FastAPI は、Python で API を構築するためのモダンなフレームワークです。高速なパフォーマンス、自動ドキュメント生成、使いやすさなどが特徴で、小規模な API やプロトタイプ作成、学習環境での利用に適しています。本記事では、FastAPI を使って簡単な API サーバーを構築する手順を説明します。
環境構築
FastAPI を利用するには、まず Python と pip がインストールされている必要があります。また、FastAPI と必要な依存関係をインストールする必要があります。
pip install fastapi uvicorn
このコマンドを実行すると、FastAPI フレームワークと Uvicorn (ASGI サーバー) がインストールされます。
簡単な API サーバーの作成
それでは、簡単な API サーバーのコードを記述します。以下はその例です。
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello, World!"}
このコードは、ルートパス "/" にアクセスされた場合に "Hello, World!" というメッセージを含む JSON 形式のデータを返します。 `@app.get("/")` は、HTTP GET リクエストが "/" に行われた場合に実行される関数を定義するデコレータです。`async` キーワードは、非同期関数であることを示します。これは、FastAPI が非同期処理をサポートしているためです。
API の実行
API サーバーを実行するには、Uvicorn サーバーを使用します。
uvicorn main:app --reload
このコマンドを実行すると、API サーバーが起動します。 `main` は、API のコードを保存しているファイルの名前 (この場合は `main.py` と仮定)、`app` は FastAPI アプリケーションオブジェクトの名前です。 `--reload` オプションは、コードを変更した場合に自動的にサーバーを再起動する機能です。
API のテスト
API が正常に動作しているか確認するには、ブラウザや curl などのツールを使用して API にリクエストを送信します。
curl http://127.0.0.1:8000/
このコマンドを実行すると、API から返された JSON 形式のデータが表示されます。
まとめ
FastAPI は、Python で API を構築するための強力なフレームワークです。本記事で説明した手順に従えば、簡単に軽量な API サーバーを構築できます。 FastAPI のドキュメント (
Comments
Post a Comment