FastAPI 最初のアプリ
このセクションでは、完全なサンプルを通して、ゼロからFastAPIアプリを作成し、コードの各行の意味を理解していきます。
最小限のアプリ
という名前のファイルを作成します。main.pyそのファイルに以下のコードを追加します:
例
# ステップ1: FastAPIクラスをインポート
# ステップ2: アプリインスタンスを作成
app = FastAPI()
# ステップ3: パス操作デコレータを定義
# ステップ4: パス操作関数を定義
@app.get("/")
async def root():
# ステップ5: レスポンス内容を返す
return {"message": "Hello World"}
アプリを起動:
$ uvicorn main:app --reload
アクセスhttp://127.0.0.1:8000すると、次のように返されます:
{"message": "Hello World"}
コードの解説
1. FastAPIをインポート
from fastapi import FastAPI
FastAPIはPythonクラスであり、APIにすべてのコア機能を提供します。Starletteから直接継承しているため、Starletteのすべての機能も使用できます。
2. アプリインスタンスを作成
app = FastAPI()
FastAPIインスタンスを作成します。変数名は通常appを使用します。このインスタンスは、すべてのAPIを作成するための主要な対話オブジェクトです。Flaskと異なり、FastAPIは__name__パラメータを渡す必要はありません。
3. パス操作デコレータを定義
@app.get("/")
このコード行はFastAPIに次のことを伝えます:ユーザーがGETメソッドでルートパス/にアクセスすると、下の関数を実行します。
ここで関係するのは2つの概念です:
| 概念 | 説明 | 例 |
|---|---|---|
| パス(Path) | URL内の最初の/以降の後半部分で、「エンドポイント」または「ルート」とも呼ばれます | /items/foo |
| オペレーション(Operation) | HTTPメソッドであり、異なる操作セマンティクスに対応します | GET、POST、PUT、DELETE |
FastAPIはすべてのHTTPメソッドのデコレータをサポートしています:
| デコレータ | HTTPメソッド | 一般的な用途 |
|---|---|---|
@app.get() | GET | データの取得・読み取り |
@app.post() | POST | 新しいデータの作成 |
@app.put() | PUT | データの完全更新 |
@app.patch() | PATCH | データの部分更新 |
@app.delete() | DELETE | データの削除 |
4. パス操作関数を定義
async def root():
これはパス操作関数で、FastAPIがGET /リクエストを受信するたびに呼び出されます。関数名は自由に付けられますが、意味のある名前を付けることをお勧めします。
関数を定義するには、async defまたは通常のdefを使用できます。FastAPIは両者の違いを自動的に処理します。非同期プログラミングに慣れていない場合は、通常のdefを使用すれば十分です。非同期については後の章で詳しく説明します。
5. レスポンス内容を返す
return {"message": "Hello World"}
関数は辞書を返します。FastAPIはそれを自動的にJSON形式のレスポンスに変換します。返せる型はdict、list、str、intなどで、FastAPIがJSON変換を自動的に処理します。
ルートを追加する
次に、パスパラメータとクエリパラメータを追加して、アプリの機能を充実させましょう:
例
app = FastAPI()
@app.get("/")
async def root():
"""ルートパス。ウェルカムメッセージを返す"""
return {"message": "Hello World"}
@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str | None = None):
"""IDに基づいて項目を取得。オプションのクエリパラメータqをサポート"""
return {"item_id": item_id, "q": q}
新しいルートのパラメータ説明:
| パラメータ | 型 | 取得元 | 説明 |
|---|---|---|---|
item_id | int | パスパラメータ | URLパスから取得します。FastAPIが文字列を自動的に整数に変換します |
q | str | None | クエリパラメータ | URLの?q=xxx部分から取得します。デフォルト値はNoneで、オプションであることを示します |
アクセステスト:
# 访问根路径
GET http://127.0.0.1:8000/
响应: {"message": "Hello World"}
# 访问带路径参数的路由
GET http://127.0.0.1:8000/items/5
响应: {"item_id": 5, "q": null}
# 同时传递路径参数和查询参数
GET http://127.0.0.1:8000/items/5?q=サンプル
响应: {"item_id": 5, "q": "サンプル"}
注意item_idの値は整数であり、5文字列ではありません。"5"これがFastAPIの型宣言によるデータ変換機能です。整数以外(例:/items/foo)を渡すと、FastAPIは明確な検証エラーメッセージを返します。
POSTリクエストを追加
次に、リクエストボディを使用するPOSTルートを追加しましょう:
例
from pydantic import BaseModel
app = FastAPI()
# リクエストボディのデータモデルを定義
class Item(BaseModel):
name: str # 必須:商品名
description: str | None = None # オプション:商品の説明
price: float # 必須:商品の価格
tax: float | None = None # オプション:税額
@app.post("/items/")
async def create_item(item: Item):
"""新しい商品を作成。JSONリクエストボディを受信"""
return item
@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item):
"""指定された商品を更新。パスパラメータとリクエストボディを同時に使用"""
return {"item_id": item_id, "item_name": item.name}
ここではPydanticのBaseModelを使用してリクエストボディの構造を定義しています。FastAPIは自動的に:
- リクエスト内のJSONデータを
Itemオブジェクトに解析します - データ型と必須フィールドを検証します
- APIドキュメントにリクエストボディの構造を表示します
PydanticはFastAPIの中核となる依存関係で、データ検証とシリアライゼーションに使用されます。その使い方については後の章で詳しく説明します。
FastAPIのパラメータ認識ルール
FastAPIは以下のルールでパラメータの取得元を自動的に識別します:
| パラメータの取得元 | 認識条件 | 例 |
|---|---|---|
| パスパラメータ | パラメータ名がルートパスの{} 中 | item_idに/items/{item_id} 中 |
| クエリパラメータ | パラメータが単一型(int、str、boolなど) | q: str | None = None |
| リクエストボディ | パラメータの型がPydanticモデル | item: Item |
同じ関数内でこれら3種類のパラメータを混在させることができ、FastAPIが自動的に正しい場所からデータを取得します。
まとめ
FastAPIアプリを作成するための核心的な手順:
- をインポート
FastAPI - アプリインスタンスを作成
app = FastAPI() - デコレータ(例:
@app.get())を使用してパス操作を定義 - パス操作関数を定義し、型アノテーションでパラメータを宣言
- を使用して
uvicorn main:app --reload開発サーバーを実行