パスパラメータと数値の検証¶
クエリパラメータに対してQueryでより多くのバリデーションとメタデータを宣言できるのと同じように、パスパラメータに対してもPathで同じ種類のバリデーションとメタデータを宣言することができます。
Pathのインポート¶
まず初めに、fastapiからPathをインポートします:
from typing import Union
from fastapi import FastAPI, Path, Query
app = FastAPI()
@app.get("/items/{item_id}")
async def read_items(
item_id: int = Path(title="The ID of the item to get"),
q: Union[str, None] = Query(default=None, alias="item-query"),
):
results = {"item_id": item_id}
if q:
results.update({"q": q})
return results
メタデータの宣言¶
パラメータはQueryと同じものを宣言することができます。
例えば、パスパラメータitem_idに対してtitleのメタデータを宣言するには以下のようにします:
from typing import Union
from fastapi import FastAPI, Path, Query
app = FastAPI()
@app.get("/items/{item_id}")
async def read_items(
item_id: int = Path(title="The ID of the item to get"),
q: Union[str, None] = Query(default=None, alias="item-query"),
):
results = {"item_id": item_id}
if q:
results.update({"q": q})
return results
備考
パスの一部でなければならないので、パスパラメータは常に必須です。
そのため、...を使用して必須と示す必要があります。
それでも、Noneで宣言しても、デフォルト値を設定しても、何の影響もなく、常に必要とされていることに変わりはありません。
必要に応じてパラメータを並び替える¶
クエリパラメータqを必須のstrとして宣言したいとしましょう。
また、このパラメータには何も宣言する必要がないので、Queryを使う必要はありません。
しかし、パスパラメータitem_idのためにPathを使用する必要があります。
Pythonは「デフォルト」を持たない値の前に「デフォルト」を持つ値を置くことができません。
しかし、それらを並び替えることができ、デフォルト値を持たない値（クエリパラメータq）を最初に持つことができます。
FastAPIでは関係ありません。パラメータは名前、型、デフォルトの宣言（Query、Pathなど）で検出され、順番は気にしません。
そのため、以下のように関数を宣言することができます:
from fastapi import FastAPI, Path
app = FastAPI()
@app.get("/items/{item_id}")
async def read_items(q: str, item_id: int = Path(title="The ID of the item to get")):
results = {"item_id": item_id}
if q:
results.update({"q": q})
return results
必要に応じてパラメータを並び替えるトリック¶
クエリパラメータqをQueryやデフォルト値なしで宣言し、パスパラメータitem_idをPathを用いて宣言し、それらを別の順番に並びたい場合、Pythonには少し特殊な構文が用意されています。
関数の最初のパラメータとして*を渡します。
Pythonはその*で何かをすることはありませんが、それ以降のすべてのパラメータがキーワード引数（キーと値のペア）として呼ばれるべきものであると知っているでしょう。それはkwargsとしても知られています。たとえデフォルト値がなくても。
from fastapi import FastAPI, Path
app = FastAPI()
@app.get("/items/{item_id}")
async def read_items(*, item_id: int = Path(title="The ID of the item to get"), q: str):
results = {"item_id": item_id}
if q:
results.update({"q": q})
return results
数値の検証: 以上¶
QueryとPath（、そして後述する他のもの）を用いて、文字列の制約を宣言することができますが、数値の制約も同様に宣言できます。
ここで、ge=1の場合、item_idは1「より大きいgか、同じe」整数でなれけばなりません。
from fastapi import FastAPI, Path
app = FastAPI()
@app.get("/items/{item_id}")
async def read_items(
*, item_id: int = Path(title="The ID of the item to get", ge=1), q: str
):
results = {"item_id": item_id}
if q:
results.update({"q": q})
return results
数値の検証: より大きいと小なりイコール¶
以下も同様です:
gt: より大きい（greaterthan）le: 小なりイコール（less than orequal）
from fastapi import FastAPI, Path
app = FastAPI()
@app.get("/items/{item_id}")
async def read_items(
*,
item_id: int = Path(title="The ID of the item to get", gt=0, le=1000),
q: str,
):
results = {"item_id": item_id}
if q:
results.update({"q": q})
return results
数値の検証: 浮動小数点、 大なり小なり¶
数値のバリデーションはfloatの値に対しても有効です。
ここで重要になってくるのはgtだけでなくgeも宣言できることです。これと同様に、例えば、値が1より小さくても0より大きくなければならないことを要求することができます。
したがって、0.5は有効な値ですが、0.0や0はそうではありません。
これはltも同じです。
from fastapi import FastAPI, Path, Query
app = FastAPI()
@app.get("/items/{item_id}")
async def read_items(
*,
item_id: int = Path(title="The ID of the item to get", ge=0, le=1000),
q: str,
size: float = Query(gt=0, lt=10.5),
):
results = {"item_id": item_id}
if q:
results.update({"q": q})
return results
まとめ¶
QueryとPath（そしてまだ見たことない他のもの）では、クエリパラメータと文字列の検証と同じようにメタデータと文字列の検証を宣言することができます。
また、数値のバリデーションを宣言することもできます:
gt: より大きい（greaterthan）ge: 以上（greater than orequal）lt: より小さい（lessthan）le: 以下（less than orequal）
情報
Query、Pathなどは後に共通のParamクラスのサブクラスを見ることになります。（使う必要はありません）
そして、それらすべては、これまで見てきた追加のバリデーションとメタデータと同じパラメータを共有しています。
技術詳細
fastapiからQuery、Pathなどをインポートすると、これらは実際には関数です。
呼び出されると、同じ名前のクラスのインスタンスを返します。
そのため、関数であるQueryをインポートし、それを呼び出すと、Queryという名前のクラスのインスタンスが返されます。
これらの関数は（クラスを直接使うのではなく）エディタが型についてエラーとしないようにするために存在します。
この方法によって、これらのエラーを無視するための設定を追加することなく、通常のエディタやコーディングツールを使用することができます。