FastAPIでCRUD APIを作ってみた備忘録
FastAPIとPostgreSQLを使って、FastAPIとPostgreSQLを組み合わせてREST APIを構築を実装したときの備忘録です。「基礎知識」「設計手順と思想」「トラブルシューティング」のメモです。
1. APIってそもそも何か?
APIは「プログラム同士の窓口」みたいなものです。
外部から決められた形式でデータを渡すと、決められた形式で結果が返ってきます。
フロントエンドや別のサービスがバックエンドにデータを取りに行くときに使われます。
例えば、
ブラウザ → サーバー
スマホアプリ → サーバー
別のバックエンド → サーバー

といった通信の入り口がAPIです。もしAPIがなかったら、フロントエンドが直接データベースを触る必要があります。これはセキュリティ的にも設計的にもかなり危険です。
APIは 「外部に公開してよい操作だけを提供する窓口」 の役割を持ちます。
APIの種類
APIの種類には、
Web API
HTTPプロトコルというルールで呼び出されるAPIのこと。HTTPプロトコルはGETメソッド、POSTメソッド、データ形式はJSONが使われることが多い。APIのほとんどがこれなので会話の中で出てくる「API」は大体これのことを指していると思っていい。言語・OSレベルのAPI
Windows API や Java API など、ライブラリやOSが提供する関数群。
2. REST API設計の原則
「RESTfulに設計しましょう」と言われるけど、抽象的で最初はピンと来ませんでした。
実装してみて初めて「こういう制約があるから楽になるんだ」と理解できました。
RESTの代表的なルール
リソースはURLで表現する(アドレス可能性)
/products/123 のように、データはURLで一意に表現する。HTTPメソッドで操作を表現する(統一インターフェース)
GET: 取得
POST: 作成
PUT: 更新
DELETE: 削除
ステートレス
サーバーはクライアントの状態を持たない。リクエストごとに完結する。リンクでリソースを辿れる(接続性)
レスポンス内に別のリソースURLを含められる設計思想。
3. FastAPIプロジェクト構成の考え方
API実装は大きく分けて次の3つで構成されます。
ルーティング(どこにアクセスするか)
データの形式(リクエスト・レスポンス)
データの保存先(DB)
ネットで調べていると、よく見る構成例としては次のようなものがあります。
app/
├── main.py #アプリの入口 。FastAPIを起動してルーターを読み込む司令塔
├── routers/ #URLと処理を書く場所 。/users などのエンドポイントを定義
│ └── users.py
├── models.py #テーブル定義を書く場所
├── database.py #DBへの接続設定を書く場所
└── schemas.py. #リクエスト・レスポンスのデータ形式 (Pydantic)を定義で、ここにきて自分がいつも疑問に思うポイントがこれです。
「どうやってこの構成決めてるん?????」「チュートリアルに書いてある通りにやればいいんか?????」
結論:役割ごとに分けているだけ
調べていく中でなんとなくわかったのは、特別なルールがあるわけではなく「役割ごとにコードを分けているだけ」 ということでした。
URLまわりの処理
データベースまわりの処理
データ構造の定義
これらは関心が違うので、別ファイルにした方が管理しやすくなります。
この考え方は「関心の分離(Separation of Concerns)」と呼ばれる様です。
4. データベース操作の選択肢
FastAPIでデータベースを操作する方法はいくつかある様です。
■ 選択肢1:生SQLを書く(psycopg2など)
Pythonから直接SQLを書く方法です。
cursor.execute("SELECT * FROM users;")SQLをそのまま書けるので挙動が分かりやすい
ただしコードが散らばりやすく、管理が大変
■ 選択肢2:SQLAlchemy Core(SQLをPythonで書く)
SQLAlchemyには「Core」という低レベルAPIがあります。
from sqlalchemy import text
db.execute(text("SELECT * FROM users"))SQLに近い書き方
Pythonで書けるので安全性が高い
複雑なクエリに強い
■ 選択肢3:SQLAlchemy ORM(今回採用)
ORM(Object Relational Mapper)は
テーブルをPythonのクラスとして扱う方法 です。
5. なぜORMを選んだのか
最初はSQLAlchemy Coreを使っていましたが、CRUD APIを書いていくうちにORMの方が便利だと感じました。
ORMを使って良かった点
Pythonオブジェクトとしてデータを扱える
CRUD処理が直感的に書ける
Pydantic(FastAPIのデータモデル)と相性が良い
型補完が効いて開発が楽
例えば、SQLを書かなくてもこう書けます。
user = db.query(User).filter(User.id == 1).first()初心者の自分には、SQLよりPythonコードの方が理解しやすかったです。
ORMのデメリット
内部でどんなSQLが流れているか見えにくい
パフォーマンスの罠があるらしい(?)
6. SQLAlchemy ORMの基本構文
ここから、実際に自分が使ったORMの最低限の書き方をまとめます。
■ モデル(テーブル)定義
from sqlalchemy.orm import declarative_base
from sqlalchemy import Column, Integer, String
Base = declarative_base()
class User(Base):
__tablename__ = "users"
id = Column(Integer, primary_key=True)
name = Column(String)
email = Column(String)PythonクラスがそのままDBのテーブルになります。
■ DB接続設定(database.py)
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker
DATABASE_URL = "postgresql://user:password@localhost:5432/testdb"
engine = create_engine(DATABASE_URL)
SessionLocal = sessionmaker(bind=engine)■ データ追加(CREATE)
db = SessionLocal()
new_user = User(name="Taro", email="taro@example.com")
db.add(new_user)
db.commit()■ データ取得(READ)
users = db.query(User).all()
user = db.query(User).filter(User.id == 1).first()■ データ更新(UPDATE)
user.name = "Hanako"
db.commit()■ データ削除(DELETE)
db.delete(user)
db.commit()