OpenAPI運用

生成

FastAPI 側でアプリを起動し、/openapi.json を取得して openapi/openapi.json に保存します。

curl http://localhost:8000/openapi.json -o openapi/openapi.json

表示

OpenAPI は以下のいずれかで参照します。

• FastAPI Swagger UI: /docs
• FastAPI ReDoc: /redoc
• Redocly / Scalar
• MkDocs からのリンク

将来の自動化

• CIで openapi/openapi.json の生成差分を検出する。
• TypeScript型生成を frontend に反映する。
• 主要endpointのAPIテストを OpenAPI ベースに寄せる。