FastAPI 自動ドキュメント生成

FastAPI アプリケーション実行

uvicorn main:app --reload

生成されたドキュメントを確認

ブラウザのURLバーへ以下を記述

http://localhost:8000/docs

以下のように表示されればOK。

上記のように作成した各APIが反映されていればOK。

タグ名の変更

ドキュメント内でグレーで塗りつぶしている箇所の一番先頭の箇所にタグ名が表示される。

ルーティングを設定する際に、独自の名前で設定が可能。

以下、タグ名を"User"に設定する例。

from fastapi import APIRouter
router = APIRouter(tags=["User"])

Follow me!