まとめ
この章では、FastAPIとSQLModelを組み合わせたREST APIの構築を体験しました。
- SQLModelのテーブルモデルを使い、Pythonのクラス定義からDBテーブルを構築できる
- 作成用(
NoteCreate)・更新用(NoteUpdate)・DB用(Note)の3種類のモデルを使い分け、責務を分離した設計ができる - 更新用モデルで
Optionalとis not Noneを組み合わせ、送られたフィールドだけを更新するAPIを実装できる - FastAPI の Depends パターンを使い、セッションの作成と解放を自動化できる
session.add()/session.get()/session.exec(select(...))/session.delete()を使い分けて、CRUD操作を実装できる- HTTPException により、
404 Not Foundなど適切なエラーレスポンスを返せる .envファイルで環境変数を管理し、接続情報をコードから分離できる- APIRouter を使い、エンドポイントを
routers/フォルダに分離することで、保守性の高い構成にできる models.py・database.py・routers/notes.py・main.pyの役割分割により、見通しの良いコードベースを作れる- 実装したエンドポイントは、Swagger UI(
/docs)からもテスト実行できる
次の章では、PythonでCORS対応を学びつつ、実際にブラウザからの呼び出しをFastAPIで許可する実装を体験します。