FastAPI 基本ルート

FastAPI では、基本ルートは API エンドポイントを定義するための鍵です。

各ルートは、アプリケーション内の関数にマッピングされ、特定の HTTP リクエストを処理し、対応するレスポンスを返します。

ルートパスルート

FastAPI インスタンスとルートパスルートを作成します:

例

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

コードの説明:

  • FastAPI():FastAPI アプリケーションインスタンスを作成します。
  • @app.get("/"):使用する@app.getデコレータを使用してルートパスを処理するルートを作成します。
  • def read_root():ルート処理関数で、{'Hello': 'World'} を含む辞書を返します。

パスパラメータ

ルートのパラメータを設定します:

例

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

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

コードの説明:

  • @app.get("/items/{item_id}"):ルートパスを定義しています。ここで{item_id}はパスパラメータであり、関数パラメータに対応します。item_id。
  • def read_item(item_id: int, q: str = None):ルート処理関数は整数型のパスパラメータを受け取りますitem_idおよびオプションの文字列型クエリパラメータq。

ルート操作では、関数パラメータを使用してクエリパラメータを宣言できます。たとえば、q: str = Noneはqはオプションの文字列型クエリパラメータで、デフォルト値はNone。

アプリケーションの起動とルートのテスト

Uvicorn を使用してアプリケーションを起動します:

uvicorn main:app --reload

アクセスhttp://127.0.0.1:8000ルートパスのレスポンスを確認します:

http://127.0.0.1:8000/items/42?q=サンプル にアクセスして、パスパラメータとクエリパラメータを含むレスポンスを確認します:

FastAPI が自動生成する対話型 API ドキュメントには、定義されたルート情報、パスパラメータ、クエリパラメータなどが含まれます。ドキュメントのアドレスにアクセスしますhttp://127.0.0.1:8000/docs詳細なドキュメントとテストインターフェースを確認します:

その他の拡張