お気に入り機能とバックエンド管理
この章では、多対多リレーションを使ってお気に入り機能を実装し、sqladminを使ってバックエンド管理を構築する方法を学びます。
多対多リレーションの設計
例
# ファイルパス: models.py 関連テーブル追加とPostモデル変更
from sqlalchemy import Table
# 関連テーブル: UserとPostの多対多中間テーブル
favorites = Table(
"favorites",
Base.metadata,
Column("user_id", Integer, ForeignKey("users.id"), primary_key=True),
Column("post_id", Integer, ForeignKey("posts.id"), primary_key=True),
Column("created_at", DateTime, default=datetime.utcnow)
)
from sqlalchemy import Table
# 関連テーブル: UserとPostの多対多中間テーブル
favorites = Table(
"favorites",
Base.metadata,
Column("user_id", Integer, ForeignKey("users.id"), primary_key=True),
Column("post_id", Integer, ForeignKey("posts.id"), primary_key=True),
Column("created_at", DateTime, default=datetime.utcnow)
)
マイグレーションを実行:
(venv) $ alembic revision --autogenerate -m "新增收藏关联表" (venv) $ alembic upgrade head
お気に入り登録・解除ルート
例
# ファイルパス: routers/favorites.py
from fastapi import APIRouter, Depends, HTTPException, Request
from sqlalchemy.orm import Session
from database import get_db
from models import Post, favorites
from routers.users import get_current_user
from fastapi.templating import Jinja2Templates
router = APIRouter(prefix="/favorites", tags=["お気に入り"])
templates = Jinja2Templates(directory="templates")
@router.post("/toggle/{post_id}")
def toggle_favorite(
post_id: int,
request: Request,
db: Session = Depends(get_db),
current_user = Depends(get_current_user) # ログインが必要
):
"""お気に入り状態を切り替える"""
post = db.query(Post).filter(Post.id == post_id).first()
if not post:
raise HTTPException(status_code=404, detail="記事が存在しません")
# お気に入り済みか確認
is_faved = db.query(favorites).filter(
favorites.c.user_id == current_user.id,
favorites.c.post_id == post.id
).first() is not None
if is_faved:
# お気に入り解除
db.execute(
favorites.delete().where(
(favorites.c.user_id == current_user.id) &
(favorites.c.post_id == post.id)
)
)
db.commit()
else:
# お気に入り追加
db.execute(
favorites.insert().values(user_id=current_user.id, post_id=post.id)
)
db.commit()
from fastapi.responses import RedirectResponse
return RedirectResponse(url=request.headers.get("referer", "/"), status_code=303)
@router.get("/", name="favorites_list")
def favorites_list(
request: Request,
db: Session = Depends(get_db),
current_user = Depends(get_current_user)
):
"""お気に入りリスト"""
faved_posts = db.query(Post).join(
favorites, (favorites.c.post_id == Post.id)
).filter(
favorites.c.user_id == current_user.id
).order_by(favorites.c.created_at.desc()).all()
return templates.TemplateResponse("favorites.html", {
"request": request,
"posts": faved_posts
})
from fastapi import APIRouter, Depends, HTTPException, Request
from sqlalchemy.orm import Session
from database import get_db
from models import Post, favorites
from routers.users import get_current_user
from fastapi.templating import Jinja2Templates
router = APIRouter(prefix="/favorites", tags=["お気に入り"])
templates = Jinja2Templates(directory="templates")
@router.post("/toggle/{post_id}")
def toggle_favorite(
post_id: int,
request: Request,
db: Session = Depends(get_db),
current_user = Depends(get_current_user) # ログインが必要
):
"""お気に入り状態を切り替える"""
post = db.query(Post).filter(Post.id == post_id).first()
if not post:
raise HTTPException(status_code=404, detail="記事が存在しません")
# お気に入り済みか確認
is_faved = db.query(favorites).filter(
favorites.c.user_id == current_user.id,
favorites.c.post_id == post.id
).first() is not None
if is_faved:
# お気に入り解除
db.execute(
favorites.delete().where(
(favorites.c.user_id == current_user.id) &
(favorites.c.post_id == post.id)
)
)
db.commit()
else:
# お気に入り追加
db.execute(
favorites.insert().values(user_id=current_user.id, post_id=post.id)
)
db.commit()
from fastapi.responses import RedirectResponse
return RedirectResponse(url=request.headers.get("referer", "/"), status_code=303)
@router.get("/", name="favorites_list")
def favorites_list(
request: Request,
db: Session = Depends(get_db),
current_user = Depends(get_current_user)
):
"""お気に入りリスト"""
faved_posts = db.query(Post).join(
favorites, (favorites.c.post_id == Post.id)
).filter(
favorites.c.user_id == current_user.id
).order_by(favorites.c.created_at.desc()).all()
return templates.TemplateResponse("favorites.html", {
"request": request,
"posts": faved_posts
})
詳細ページにお気に入りボタンを追加
例
<!-- ファイルパス: templates/post_detail.html タイトル下 -->
<div class="post-header">
<h1>{{ post.title }}</h1>
<form method="post" action="/favorites/toggle/{{ post.id }}">
<button type="submit" class="fav-btn">♡ お気に入り</button>
</form>
</div>
<div class="post-header">
<h1>{{ post.title }}</h1>
<form method="post" action="/favorites/toggle/{{ post.id }}">
<button type="submit" class="fav-btn">♡ お気に入り</button>
</form>
</div>
sqladmin — バックエンド管理
sqladminFastAPIエコシステムでDjango Adminに相当するバックエンド管理拡張機能です。
SQLAlchemy専用に設計されており、FastAPIとシームレスに統合できます。
(venv) $ pip install sqladmin
例
# ファイルパス: main.py で sqladmin を設定
from sqladmin import Admin, ModelView
from database import engine
from models import Post, Category, User
class PostAdmin(ModelView, model=Post):
column_list = [Post.id, Post.title, Post.category, Post.created_at]
column_searchable_list = [Post.title, Post.summary]
column_sortable_list = [Post.created_at, Post.title]
form_columns = [Post.title, Post.slug, Post.summary, Post.content, Post.category_id]
class CategoryAdmin(ModelView, model=Category):
column_list = [Category.id, Category.name, Category.slug]
form_columns = [Category.name, Category.slug]
class UserAdmin(ModelView, model=User):
column_list = [User.id, User.username, User.email]
column_searchable_list = [User.username, User.email]
# パスワードフィールドを表示しない(セキュリティ上の理由)
form_excluded_columns = [User.hashed_password]
# Adminインスタンスを作成し、FastAPIアプリにバインド
admin = Admin(app, engine, title="サンプル ブログバックエンド")
admin.add_view(PostAdmin)
admin.add_view(CategoryAdmin)
admin.add_view(UserAdmin)
from sqladmin import Admin, ModelView
from database import engine
from models import Post, Category, User
class PostAdmin(ModelView, model=Post):
column_list = [Post.id, Post.title, Post.category, Post.created_at]
column_searchable_list = [Post.title, Post.summary]
column_sortable_list = [Post.created_at, Post.title]
form_columns = [Post.title, Post.slug, Post.summary, Post.content, Post.category_id]
class CategoryAdmin(ModelView, model=Category):
column_list = [Category.id, Category.name, Category.slug]
form_columns = [Category.name, Category.slug]
class UserAdmin(ModelView, model=User):
column_list = [User.id, User.username, User.email]
column_searchable_list = [User.username, User.email]
# パスワードフィールドを表示しない(セキュリティ上の理由)
form_excluded_columns = [User.hashed_password]
# Adminインスタンスを作成し、FastAPIアプリにバインド
admin = Admin(app, engine, title="サンプル ブログバックエンド")
admin.add_view(PostAdmin)
admin.add_view(CategoryAdmin)
admin.add_view(UserAdmin)
/admin にアクセスするとバックエンド管理画面に入ります。
sqladmin vs Flask-Admin vs Django Admin
| 特徴 | Django Admin | Flask-Admin | sqladmin |
|---|---|---|---|
| 登録方法 | admin.site.register() | admin.add_view(ModelView()) | Admin + add_view |
| ORMサポート | Django ORM | SQLAlchemy / MongoEngine | SQLAlchemy(のみ) |
| 認証サポート | 組み込み | 手動統合が必要 | 組み込み authentication_backend |
| 非同期サポート | サポートなし | サポートなし | ネイティブ async |
sqladmin はデフォルトではログインなしでアクセスできます。本番環境では設定が必要です。
authentication_backend認証保護を追加するには、sqladmin公式ドキュメントを参照してください。
本章のまとめ
この章では、2つの重要な機能を実装しました:Table関連テーブルを使ってお気に入りの多対多リレーションを実装し、sqladminを使ってバックエンド管理システムを素早く構築しました。
これでブログのユーザーインタラクション(登録、ログイン、お気に入り)と管理機能(Adminバックエンド)がすべて整いました。
その他の拡張