パラメータ化されたリクエストに対して FastAPI でパスパラメータを使用する方法-Python チュートリアル-php.cn

FastAPI でパラメータ化されたリクエストにパスパラメータを使用する方法

FastAPI は、標準 API (Pydantic や OpenAPI など) に基づいて開発された、高速 (高パフォーマンス) で使いやすい最新の Web フレームワークです。 FastAPI では、パスパラメータを使用してリクエストをパラメータ化し、さまざまなリクエストをより適切に処理できます。

パスパラメーターは、リソースの特定のインスタンスを識別するために使用される URL の部分を指します。パスパラメーターを使用すると、さまざまなニーズに応じて Web API から特定のデータを取得できます。以下では、パスパラメーターを使用して FastAPI でパラメーター化されたリクエストを行う方法を紹介し、対応するコード例を示します。

まず、FastAPIモジュールとPathモジュールをインポートし、appオブジェクトを作成する必要があります:

from fastapi import FastAPI, Path app = FastAPI()

ログイン後にコピー

次に、ルーティングパスでパスパラメータを定義できます。パスパラメーターは中括弧で囲まれた文字列で、パラメーターの名前とデータ型を定義できます。たとえば、item_idのパスパラメータを定義できます:

@app.get("/items/{item_id}") async def read_item(item_id: int): return {"item_id": item_id}

ログイン後にコピー

上記の例では、ルーティングパス/items/{item_id}を定義します。パスパラメーターitem_idのデータ型をintとして定義します。関数パラメータでは、パスパラメータの名前item_idを直接使用して値を取得できます。

サーバー/items/42にリクエストを送信すると、FastAPI はパスパラメーターの値を対応する関数に自動的に渡し、パラメーターの値として返します。上の例では、パラメータの名前と値を含む JSON オブジェクトが返されます。

{"item_id": 42}

ログイン後にコピー

path パラメータに他のパラメータを指定することもできます。たとえば、パスパラメータの最小値と最大値を指定できます。以下は例です:

@app.get("/users/{user_id}") async def read_user(user_id: int = Path(..., ge=1, le=100)): return {"user_id": user_id}

ログイン後にコピー

上の例では、2 つのパラメータgeとleを使用してuser_idの範囲を制限します。これは、user_idの値が 1 以上、100 以下である必要があることを示します。送信するリクエストのuser_idがこの範囲を超える場合、FastAPI は HTTP 例外応答を送信します。

通常のデータ型に加えて、パスパラメーターのデータ型として列挙型も使用できます。以下に例を示します。

from enum import Enum class Size(str, Enum): small = "small" medium = "medium" large = "large" @app.get("/items/{item_id}/size/{size}") async def read_item_size(item_id: int, size: Size): return {"item_id": item_id, "size": size}

ログイン後にコピー

上の例では、Size列挙クラスを定義し、それをパラメータsizeのデータ型として使用します。リクエスト/items/42/size/smallを送信すると、FastAPI はパスパラメーターの値を対応する関数に渡し、パラメーターの値として返します。

パスパラメーターを使用してリクエストをパラメーター化することは、FastAPI を使用して Web API でさまざまなリクエストを処理するための重要な手法の 1 つです。パスパラメーターを通じて、さまざまなルーティングパスを定義し、さまざまなニーズに応じてサーバーから特定のデータを取得できます。上記の例では、パスパラメーターを使用してリクエストをパラメーター化する方法を示し、対応するコード例を提供します。

要約すると、パスパラメーターを使用して FastAPI でパラメーター化されたリクエストを行う手順は次のとおりです。