FastAPIでオプションパラメータを使用する方法

2024-03-08 00:03 FastAPI Python
  1. オプションパラメータの定義: FastAPIでは、パラメータをオプションとするには、パラメータの型の後にデフォルト値を指定します。以下は例です。
from fastapi import FastAPI
app = FastAPI()
@app.get("/items/{item_id}")
def read_item(item_id: int, optional_param: str = None):
    item = {"item_id": item_id, "optional_param": optional_param}
    return item

上記の例では、optional_paramはオプションのパラメータであり、デフォルト値としてNoneが指定されています。

  1. オプションパラメータの使用: オプションパラメータは、リクエスト時に値が提供されなかった場合に、デフォルト値が使用されます。以下は、オプションパラメータを使用したAPIエンドポイントの例です。
@app.get("/items/{item_id}")
def read_item(item_id: int, optional_param: str = None):
    item = {"item_id": item_id, "optional_param": optional_param}
    return item

上記の例では、optional_paramはリクエスト時に省略可能なパラメータです。もしリクエスト時にoptional_paramの値が提供されなかった場合、optional_paramの値はNoneとなります。

以上が、FastAPIでオプションパラメータを使用する方法の簡単な解説とコード例です。これを参考にして、自身のFastAPIプロジェクトでオプションパラメータを活用してみてください。