概要
SQLModelのWebAPIのシンプルなサンプルコードを紹介します。
コード一式は、下記にあります。すべてを確認するためには、Download ZIPからZIPをダウンロードしてください。
最初に、テーブルと機能を説明し、続いて、環境構築や実行方法を説明します。
最後に、ファイル構成と、抜粋したコードや補足の説明をします。
参考
- FastAPI版のサンプルコードの記事もあります。
テーブルとカラム
著者テーブルと書籍テーブルを操作します。データベースは、SQLiteを使います。
| テーブル | カラム |
|---|---|
著者（Author） |
ID（id）、名前（name）、書籍（books） |
書籍（Book） |
ID（id）、名前（name）、著者ID（author_id）、著者（author） |
-
Book.author_idは、Author.idの外部キーです。 -
Author.booksとBook.authorは、リレーション用です。
機能
2つの表を操作する12の機能があります。
| method | パスとパラメーター | 関数 | 説明 |
|---|---|---|---|
| POST | /authors?author=* |
add_author() |
著者の追加 |
| GET | /authors |
get_authors() |
全著者の取得 |
| GET | /authors/<author_id> |
get_author() |
指定著者の取得 |
| GET | /authors/<author_id>/details |
author_details() |
指定著者の詳細 |
| PATCH | /authors?author_id=*&author=* |
update_author() |
指定著者の更新 |
| DELETE | /authors?author_id=* |
delete_author() |
指定著者の削除 |
| POST | /books?book=* |
add_book() |
書籍の追加 |
| GET | /books |
get_books() |
全書籍の取得 |
| GET | /books/<book_id> |
get_books() |
指定書籍の取得 |
| GET | /books/<book_id>/details |
book_details() |
指定書籍の詳細 |
| PATCH | /books?book_id=*&book=* |
update_book() |
指定書籍の更新 |
| DELETE | /books?book_id=* |
delete_book() |
指定書籍の削除 |
- 著者と書籍が親子構造になっています
- 書籍を追加するには、親となる著者が必要です
- 指定著者を削除すると、子供である書籍も削除されます
環境構築
Python 3.12で動作します。Poetryが必要です。
以下のようにしてFastAPIの仮想環境を作成します。
poetry install
FastAPIの起動
以下のようにしてFastAPIを起動します。
poetry run uvicorn src.main:app --host 0.0.0.0 --reload
対話的APIドキュメント
下記から対話的APIドキュメント（Swagger UI）が使えます。
REST APIのファイル構成
APIはsrcディレクトリにあり、下記の3つのファイルからなります。
-
__init__.py：パッケージ化するための空のファイルです。 -
main.py：パスオペレーション関数を定義しています。 -
models.py：SQLModelのクラスと関数（init_db、get_db）を定義しています。
main.py（抜粋）
main.pyでは、主にパスオペレーション関数を定義しています。Depends(get_db)とすることで、get_dbを差し替えられるようにしています。
@app.get("/authors", tags=["/authors"])
async def get_authors(db: AsyncSession = Depends(get_db)) -> list[AuthorGet]:
return await db.scalars(select(Author))
models.py（抜粋）
models.pyは、SQLModelのクラスを定義しています。
class Author(AuthorBase, table=True):
id: int | None = Field(default=None, primary_key=True)
books: list["Book"] = Relationship(
back_populates="author", sa_relationship_kwargs={"cascade": "delete"}
)
FastAPIでは、通常、「検証用のPydanticのクラス」と「ORM用のSQLAlchemyのクラス」が必要でした。しかし、SQLModelのモデルでは検証とORMでクラスを分ける必要がありません。
今回は、モデルのクラスを下記のように定義しています。AuthorとBookがDBのテーブルと対応します。
| クラス名 | 基底クラス | 目的 |
|---|---|---|
| AuthorBase | SQLModel | id以外のデータ |
| Author | AuthorBase | idを含むデータ |
| AuthorAdd | AuthorBase | 追加時の引数用 |
| AuthorGet | AuthorAdd | 取得時の戻り値用 |
| AuthorGetWithBooks | AuthorGet | 詳細時の戻り値用 |
| AuthorUpdate | SQLModel | 更新時の引数用 |
| BookBase | SQLModel | id以外のデータ |
| Book | BookBase | idを含むデータ |
| BookAdd | BookBase | 追加時の引数用 |
| BookGet | BookAdd | 取得時の戻り値用 |
| BookGetWithAuthor | BookGet | 詳細時の戻り値用 |
| BookUpdate | SQLModel | 更新時の引数用 |
SQLModelは、目的に応じたクラスを作ることで、シンプルな記述で安全に動作するようになっています。
pytestの実行
下記のようにして、12の機能をテストします。
poetry run pytest
テストでは、別のengineを使うように、get_dbをget_test_dbで差し替えています。
engine = create_async_engine("sqlite+aiosqlite:///:memory:")
...
async def get_test_db():
async with AsyncSession(engine) as session:
yield session
app.dependency_overrides[get_db] = get_test_db
リレーションのデータの取得について補足
SQLAlchemy ORMのBookクラスは、親のAuthorのリレーション（author）を持っています。
class Book(BookBase, table=True):
id: int | None = Field(default=None, primary_key=True)
author: Author | None = Relationship(back_populates="books")
Book.authorの情報を取得するには、下記のようにoptions(selectinload(Book.author))を使います。
@app.get("/books/{book_id}/details", tags=["/books"])
async def get_book_details(book_id: int, db: AsyncSession = Depends(get_db)) -> BookGetWithAuthor:
book = await db.scalar(
select(Book).where(Book.id == book_id).options(selectinload(Book.author))
)
if not book:
raise HTTPException(status.HTTP_404_NOT_FOUND, detail="Unknown book_id")
return book
以上