FastAPIとは
FastAPIは、Pythonの非常に高速（高性能）、使いやすい、モダンな、高速（クイック）なWebフレームワークです。これは、Python 3.6以降の型ヒントに基づいています。
FastAPIの主な特徴は次のとおりです：
- 高速: NodeJSやGoと同等の非常に高速なパフォーマンスを持っています（StarletteとPydanticのおかげです）。
- 高速な開発: 約2〜3倍の開発速度を提供します。開発時間を大幅に短縮し、バグを減らします。
- 少ないバグ: 開発者エラーを減らすためのシステム。開発者が間違ったコードを書くのを防ぎます。
- 直感的: 素晴らしいエディタのサポート。自動補完がどこでも機能します。これにより、開発時間が大幅に短縮されます。
- 簡単: 高度に直感的で使いやすい設計。ドキュメンテーションを読む時間を大幅に短縮します。
- 短い: コードの重複を最小限に抑えます。各パラメータから複数の機能を持つ。少ないバグ。
- 堅牢: プロダクションでの使用を目的としたコード。自動対話式ドキュメンテーションを提供します。
- 基準に基づく: OpenAPI（以前はSwagger）とJSON Schemaの基準に基づいています。
- Pythonic: Starlette（Web部分）とPydantic（データ部分）に深く根ざしています。Pythonの直感的なスタイルを尊重します。
FastAPIを使用すると、簡単に高品質なWeb APIを作成できます。また、そのパフォーマンスは、他のPythonフレームワークと比較して非常に優れています。これらの特性により、FastAPIはPythonでWeb APIを開発するための優れた選択肢となっています。
BackgroundTasksの基本
FastAPIのBackgroundTasksクラスは、HTTPレスポンスを返した後に非同期に実行するタスクを追加するためのものです。これは、長時間実行する必要があるが、クライアントにすぐにレスポンスを返したい場合などに便利です。
以下に、BackgroundTasksの基本的な使用方法を示します。
from fastapi import BackgroundTasks, FastAPI
app = FastAPI()
def write_log(message: str):
with open("log.txt", mode="a") as log:
log.write(message)
@app.post("/send-notification/{message}")
async def send_notification(message: str, background_tasks: BackgroundTasks):
background_tasks.add_task(write_log, message)
return {"message": "Notification sent in the background"}
上記の例では、write_log関数がバックグラウンドタスクとして追加されています。この関数は、指定されたメッセージをlog.txtファイルに書き込みます。このタスクは、エンドポイントの主要な処理が完了し、HTTPレスポンスが送信された後に実行されます。
BackgroundTasksを使用すると、ユーザー体験を損なうことなく、時間のかかるタスクを効率的に処理することができます。これは、FastAPIの強力な機能の一つです。
JSONResponseの基本
FastAPIのJSONResponseクラスは、JSON形式でHTTPレスポンスを返すためのものです。これは、APIエンドポイントからデータを返す際によく使用されます。
以下に、JSONResponseの基本的な使用方法を示します。
from fastapi import FastAPI
from fastapi.responses import JSONResponse
app = FastAPI()
@app.get("/items/{item_id}")
async def read_item(item_id: str):
data = {"item_id": item_id, "name": "Fantastic Item"}
return JSONResponse(content=data)
上記の例では、read_item関数がJSONResponseを返しています。この関数は、指定されたitem_idと固定の名前を持つアイテムのデータをJSON形式で返します。
JSONResponseを使用すると、クライアントに対して構造化されたデータを簡単に返すことができます。これは、FastAPIの強力な機能の一つです。
BackgroundTasksとJSONResponseの組み合わせ
FastAPIのBackgroundTasksとJSONResponseを組み合わせることで、非同期にバックグラウンドタスクを実行しつつ、クライアントに対してJSON形式でレスポンスを返すことが可能になります。
以下に、BackgroundTasksとJSONResponseの組み合わせた使用例を示します。
from fastapi import BackgroundTasks, FastAPI
from fastapi.responses import JSONResponse
app = FastAPI()
def write_log(message: str):
with open("log.txt", mode="a") as log:
log.write(message)
@app.post("/send-notification/{message}")
async def send_notification(message: str, background_tasks: BackgroundTasks):
background_tasks.add_task(write_log, message)
return JSONResponse(content={"message": "Notification sent in the background"})
上記の例では、send_notification関数がBackgroundTasksを使用してwrite_log関数をバックグラウンドタスクとして追加し、同時にJSONResponseを使用してクライアントに対してJSON形式でレスポンスを返しています。
このように、BackgroundTasksとJSONResponseを組み合わせることで、非同期にバックグラウンドタスクを実行しつつ、クライアントに対して即時にレスポンスを返すことが可能になります。これは、FastAPIの強力な機能の一つです。
具体的な使用例
FastAPIのBackgroundTasksとJSONResponseを組み合わせた具体的な使用例を以下に示します。
from fastapi import BackgroundTasks, FastAPI
from fastapi.responses import JSONResponse
import time
app = FastAPI()
def write_log(message: str):
time.sleep(10) # この行は時間のかかる処理をシミュレートします。
with open("log.txt", mode="a") as log:
log.write(message)
@app.post("/send-notification/{message}")
async def send_notification(message: str, background_tasks: BackgroundTasks):
background_tasks.add_task(write_log, message)
return JSONResponse(content={"message": "Notification sent in the background"})
上記の例では、send_notificationエンドポイントは、指定されたメッセージをlog.txtファイルに書き込むバックグラウンドタスクを追加し、その後すぐにJSON形式でレスポンスをクライアントに返します。
この例では、write_log関数内のtime.sleep(10)は時間のかかる処理をシミュレートしています。この処理が完了するまでに10秒かかりますが、BackgroundTasksを使用することで、この処理が完了するのを待たずにクライアントに対してレスポンスを返すことができます。
これは、FastAPIのBackgroundTasksとJSONResponseを組み合わせて使用する一例です。このように、時間のかかるタスクをバックグラウンドで実行しつつ、クライアントに対して即時にレスポンスを返すことが可能になります。これは、FastAPIの強力な機能の一つです。
まとめ
この記事では、FastAPIのBackgroundTasksとJSONResponseについて詳しく説明しました。これらの機能を組み合わせることで、非同期にバックグラウンドタスクを実行しつつ、クライアントに対して即時にレスポンスを返すことが可能になります。
具体的には、BackgroundTasksを使用することで、時間のかかるタスクをバックグラウンドで実行することができます。これにより、クライアントに対して即時にレスポンスを返すことが可能になり、ユーザー体験を向上させることができます。
一方、JSONResponseを使用することで、クライアントに対して構造化されたデータを簡単に返すことができます。これにより、クライアントは返されたデータを容易に解析することができます。
FastAPIは、これらの機能を備えた高性能なWebフレームワークであり、APIの開発を効率的に行うことができます。今後もFastAPIの活用を進めていきましょう。この記事が皆さんの参考になれば幸いです。それでは、Happy coding! 🚀