FastAPI リクエストとレスポンス

FastAPI では、リクエスト(Request)とレスポンス(Response)はクライアントとの対話の中核です。

FastAPI は、リクエストデータを解析し、必要に応じて標準的なレスポンスを生成するための強力なツールを提供します。

次に、FastAPI のリクエストとレスポンスについて詳しく見ていきましょう。

HTTP に関する内容は以下を参照してください:HTTP リクエストメソッド。

リクエストデータ

クエリパラメータ

以下の例では、次を定義しました。/items/ルートは、2つのクエリパラメータを受け取ります。skipとlimitそれらの型はすべて整数で、デフォルト値はそれぞれ次のとおりです。0と10。

例

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
def read_item(skip: int = 0, limit: int = 10):
    return {"skip": skip, "limit": limit}

コマンドラインで以下のコマンドを実行してアプリを起動します:

uvicorn main:app --reload

では、ブラウザを開いてアクセスしてください。http://127.0.0.1:8000/items/デフォルトの JSON データが返されます:

渡すGETリクエストのパラメータhttp://127.0.0.1:8000/items/?skip=1&limit=5返される JSON データは以下のとおりです:

パスパラメータ

URL をより見やすくするために、パラメータをパスに設定することができます。

以下の例では、パスパラメータとitem_idクエリパラメータをq持つルートを定義しました。

例

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

渡すGETリクエストのパラメータhttp://127.0.0.1:8000/items/5/?q=サンプル返される JSON データは以下のとおりです:

リクエストボディ

次に、以下を作成しました。/items/ルート。使用する@app.postデコレータは、これが処理することを示します。POSTリクエストのルート。

例

from pydantic import BaseModel
from fastapi import FastAPI

app = FastAPI()
class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

@app.post("/items/")
def create_item(item: Item):
    return item

Pydantic モデル Item を使用してリクエストボディを定義しました。複数のフィールドが含まれ、その一部にはデフォルト値があります。Pydantic の詳細は以下を参照してください:FastAPI Pydantic モデル。

次に、以下を開くことができます。http://127.0.0.1:8000/docsを使用して POST テストを行います:

リクエストパラメータを入力:

戻り値は以下のとおりです:


レスポンスデータ

JSON データを返す

ルートハンドラ関数が辞書を返すと、その辞書は FastAPI によって自動的に JSON 形式に変換され、レスポンスとしてクライアントに送信されます:

例

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
def read_item(skip: int = 0, limit: int = 10):
    return {"skip": skip, "limit": limit}

上記のコードをブラウザでアクセスすると、http://127.0.0.1:8000/items/JSON データが返されます:

Pydantic モデルを返す

ルートハンドラ関数が Pydantic モデルインスタンスを返すと、FastAPI はそれを自動的に JSON 形式に変換し、レスポンスとしてクライアントに送信します:

例

from pydantic import BaseModel
from fastapi import FastAPI

app = FastAPI()
class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

@app.post("/items/")
def create_item(item: Item):
    return item

POST リクエストの場合、返されるデータ形式は以下のとおりです:

{
  "name": "サンプル",
  "description": "サンプル POST 测试",
  "price": 12,
  "tax": 1
}

リクエストヘッダーと Cookie

Header と Cookie の型アノテーションを使用して、リクエストヘッダーと Cookie データを取得します。

例

from fastapi import Header, Cookie
from fastapi import FastAPI

app = FastAPI()

@app.get("/items/")
def read_item(user_agent: str = Header(None), session_token: str = Cookie(None)):
    return {"User-Agent": user_agent, "Session-Token": session_token}

上記のコードをブラウザでアクセスすると、http://127.0.0.1:8000/items/JSON データが返されます:


リダイレクトとステータスコード

使用するRedirectResponseリダイレクトを実装し、クライアントを/items/ルートへリダイレクトします。

例

from fastapi import Header, Cookie
from fastapi import FastAPI
from fastapi.responses import RedirectResponse

app = FastAPI()

@app.get("/items/")
def read_item(user_agent: str = Header(None), session_token: str = Cookie(None)):
    return {"User-Agent": user_agent, "Session-Token": session_token}

@app.get("/redirect")
def redirect():
    return RedirectResponse(url="/items/")

上記のコードをブラウザでアクセスすると、http://127.0.0.1:8000/redirect/自動的にhttp://127.0.0.1:8000/items/ページにジャンプします:

HTTPException を使用して例外をスローし、カスタムのステータスコードと詳細情報を返します。

以下の例では、item_idために42が返されます。404ステータスコード:

例

from fastapi import HTTPException

app = FastAPI()

@app.get("/items/{item_id}")
def read_item(item_id: int):
    if item_id == 42:
        raise HTTPException(status_code=404, detail="Item not found")
    return {"item_id": item_id}

上記のコードをブラウザでアクセスすると、http://127.0.0.1:8000/items/42/ページは次のように表示されます:


カスタムレスポンスヘッダー

使用するJSONResponseカスタムレスポンスヘッダー:

例

from fastapi import FastAPI
from fastapi.responses import JSONResponse

app = FastAPI()

@app.get("/items/{item_id}")
def read_item(item_id: int):
    content = {"item_id": item_id}
    headers = {"X-Custom-Header": "custom-header-value"}
    return JSONResponse(content=content, headers=headers)

上記のコードをブラウザでアクセスすると、http://127.0.0.1:8000/items/42/ページは次のように表示され、カスタムのレスポンスヘッダーを確認できます:

その他の拡張