FastAPI: Pydantic を使用してクエリパラメーターを宣言する方法-Python チュートリアル-php.cn

FastAPI: Pydantic を使用してクエリパラメーターを宣言する方法

Linda Hamilton

リリース： 2024-10-10 06:11:30

オリジナル

880 人が閲覧しました

これは、FastAPI で最も期待されていた機能の 1 つで、約 3 週間前にリリースされました。少なくとも、Pydantic モデル FastAPI について話しているときは。

はい、Pydantic モデルを使用してクエリパラメーターをマッピングできる機能について話しています。

それでは、この投稿では、あなたのすべてを紹介しようと思います?できますか？この件に関してはどうすることもできない?:

?クエリパラメータのマッピング

Pydantic でクエリパラメーターのマッピングを開始するために最初に行う必要があるのは、FastAPI バージョン 0.115.0 を使用していることを確認することです。

この後、いつでも FastAPI ドキュメントにアクセスして、すでに利用可能なものを確認できます。 Sebastián とチームメンバーは、ドキュメントを常に最新の状態に保ち、有益な情報を提供することに本当に本当によく取り組んでいます ✨.

?ちょっとした歴史

FastAPI でクエリパラメーターをマッピングする方法について、いくつかの例から始めましょう。 ?

これを行う最も簡単な方法は次のとおりです:

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def search(
    limit: int | None = 10,
    skip: int | None = 1,
    filter: str | None = None
):
    return {
        "limit": limit,
        "skip": skip,
        "filter": filter
    }

ログイン後にコピー

これで、次のように呼び出すことができます。

GET http://localhost:8000/?limit=42&skip=12&filter=banana

ログイン後にコピー

しかし、このクエリパラメータが他のルートで使用されることが特定された場合は、次のようなものでそれを分離します。

from typing import Any
from fastapi import Depends, FastAPI, Query

app = FastAPI()

async def pagination_query_string(
    limit: int | None = Query(10, ge=5, le=100),
    skip: int | None = Query(1, ge=1),
    filter: str | None = Query(None)
) -> dict[str, Any]:
    return {
        "limit": limit,
        "skip": skip,
        "filter": filter
    }

@app.get("/")
async def search(q: dict[str, Any] = Depends(pagination_query_string)):
    return q

ログイン後にコピー

または、モデルのマッピングに Pydantic を使用しているため、少しリファクタリングするだけで次のようになります。

from fastapi import Depends, FastAPI, Query
from pydantic import BaseModel

app = FastAPI()

class PaginationQueryString(BaseModel):
    limit: int | None = 10
    skip: int | None = 1
    filter: str | None = None

async def pagination_query_string(
    limit: int | None = Query(10, ge=5, le=100),
    skip: int | None = Query(1, ge=1),
    filter: str | None = Query(None)
) -> PaginationQueryString:
    return PaginationQueryString(
        limit=limit,
        skip=skip,
        filter=filter
    )

@app.get("/")
async def search(q: PaginationQueryString = Depends(pagination_query_string)):
    return q

ログイン後にコピー

⌨️ Pydantic を使用してクエリ文字列をマッピングする

FastAPI: How to use Pydantic to declare Query Parameters

クエリ文字列を取得したい場合、関数を作成して依存関係として追加する必要はありません。 PaginationQueryString 型のオブジェクトが必要であり、それがクエリ文字列であることを FastAPI に伝えるだけです:

from typing import Annotated
from fastapi import FastAPI, Query
from pydantic import BaseModel

app = FastAPI()

class PaginationQueryString(BaseModel):
    limit: int | None = 10
    skip: int | None = 1
    filter: str | None = None

@app.get("/")
async def search(q: Annotated[PaginationQueryString, Query()]):
    return q

ログイン後にコピー

簡単ですね? ?

⚠️制限は何ですか?

少なくともバージョン 0.115.0 では、ネストされたモデルではあまりうまく機能しません。

次のようなことを試してみましょう:

from typing import Annotated
from fastapi import FastAPI, Query
from pydantic import BaseModel

app = FastAPI()

class Filter(BaseModel):
    name: str | None = None
    age: int | None = None
    nickname: str | None = None

class PaginationQueryString(BaseModel):
    limit: int | None = 10
    skip: int | None = 1
    filter: Filter | None = None

@app.get("/")
async def search(q: Annotated[PaginationQueryString, Query()]):
    return q

ログイン後にコピー

前のように呼び出した場合:

GET http://localhost:8000/?limit=42&skip=12&filter=chocolate

ログイン後にコピー

フィルターがオブジェクトであることを示すエラーが表示されます:

{
    "detail": [
        {
            "type": "model_attributes_type",
            "loc": [
                "query",
                "filter"
            ],
            "msg": "Input should be a valid dictionary or object to extract fields from",
            "input": "chocolate"
        }
    ]
}

ログイン後にコピー

少なくとも現時点では、それは絶対に正しいです!フィルターを文字列ではなく Pydantic モデルに変更しました。しかし、これを辞書に変換しようとすると、次のようになります。

http://localhost:8000/?limit=42&skip=12&filter={%22name%22:%20%22Rafael%22,%20%22age%22:%2038,%20%22nickname%22:%20%22ceb10n%22}

ログイン後にコピー

FastAPI は、フィルターが有効な辞書である必要があることを示します ?:

{
    "detail": [
        {
            "type": "model_attributes_type",
            "loc": [
                "query",
                "filter"
            ],
            "msg": "Input should be a valid dictionary or object to extract fields from",
            "input": "{\"name\": \"Rafael\", \"age\": 38, \"nickname\": \"ceb10n\"}"
        }
    ]
}

ログイン後にコピー

FastAPI が Starlette の QueryParams に依存し、辞書ではなく文字列を FastAPI に与えるため、この問題が発生します。少なくともバージョン 0.115.0 では、エラーが発生します。