6: Todoの更新

このステップで学ぶこと

今回はTodoの更新機能を作成します。
APIを通じてTodoを編集できるようにしましょう。

Todo更新機能の作成

todo-api/app/main.py を以下のように変更してTodoの更新機能を作成します:

from fastapi import FastAPI, Depends, HTTPException
from sqlalchemy.orm import Session
from . import models, schemas
from .database import engine, get_db

models.Base.metadata.create_all(bind=engine)

app = FastAPI()

# Todoの一覧取得
@app.get("/todos/", response_model=list[schemas.Todo])
def read_todos(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
    todos = db.query(models.Todo).offset(skip).limit(limit).all()
    return todos

# 特定のTodoの取得
@app.get("/todos/{todo_id}", response_model=schemas.Todo)
def read_todo(todo_id: int, db: Session = Depends(get_db)):
    db_todo = db.query(models.Todo).filter(models.Todo.id == todo_id).first()

    # Todoが存在しない場合は404エラーを返す
    if db_todo is None:
        raise HTTPException(status_code=404, detail="Todo not found")

    return db_todo

# Todoの作成
@app.post("/todos/", response_model=schemas.Todo)
def create_todo(todo: schemas.TodoCreate, db: Session = Depends(get_db)):
    # 1. 新しいTodoインスタンスの作成
    db_todo = models.Todo(title=todo.title)

    # 2. データベースに追加
    db.add(db_todo)

    # 3. 変更を保存
    db.commit()

    # 4. データベースから最新のデータを取得
    db.refresh(db_todo)

    # 5. 作成したTodoを返す
    return db_todo

# 1. Todoの更新
@app.put("/todos/{todo_id}", response_model=schemas.Todo)
def update_todo(todo_id: int, todo: schemas.TodoCreate, db: Session = Depends(get_db)):
    # 指定されたIDのTodoを取得
    db_todo = db.query(models.Todo).filter(models.Todo.id == todo_id).first()

    # Todoが存在しない場合は404エラーを返す
    if db_todo is None:
        raise HTTPException(status_code=404, detail="Todo not found")

    # Todoのタイトルを更新
    db_todo.title = todo.title

    # データベースに変更を保存
    db.commit()
    db.refresh(db_todo)

    return db_todo

# 2. Todoの完了状態の更新
@app.patch("/todos/{todo_id}/complete", response_model=schemas.Todo)
def complete_todo(todo_id: int, db: Session = Depends(get_db)):
    # 指定されたIDのTodoを取得
    db_todo = db.query(models.Todo).filter(models.Todo.id == todo_id).first()

    # Todoが存在しない場合は404エラーを返す
    if db_todo is None:
        raise HTTPException(status_code=404, detail="Todo not found")

    # Todoの完了状態を更新
    db_todo.completed = True

    # データベースに変更を保存
    db.commit()
    db.refresh(db_todo)

    return db_todo

コードの解説

Todoの更新

@app.put("/todos/{todo_id}", response_model=schemas.Todo)
def update_todo(todo_id: int, todo: schemas.TodoCreate, db: Session = Depends(get_db)):
    db_todo = db.query(models.Todo).filter(models.Todo.id == todo_id).first()
    if db_todo is None:
        raise HTTPException(status_code=404, detail="Todo not found")
    db_todo.title = todo.title
    db.commit()
    db.refresh(db_todo)
    return db_todo

@app.put("/todos/{todo_id}"): PUTリクエストを処理するエンドポイントを定義します
todo: schemas.TodoCreate: リクエストボディの形式を指定します
db_todo.title = todo.title: Todoのタイトルを更新します
db.commit(): 変更をデータベースに保存します
db.refresh(db_todo): 更新後のデータを再取得します

Todoの完了状態の更新

@app.patch("/todos/{todo_id}/complete", response_model=schemas.Todo)
def complete_todo(todo_id: int, db: Session = Depends(get_db)):
    db_todo = db.query(models.Todo).filter(models.Todo.id == todo_id).first()
    if db_todo is None:
        raise HTTPException(status_code=404, detail="Todo not found")
    db_todo.completed = True
    db.commit()
    db.refresh(db_todo)
    return db_todo

@app.patch("/todos/{todo_id}/complete"): PATCHリクエストを処理するエンドポイントを定義します
db_todo.completed = True: Todoの完了状態を更新します
db.commit(): 変更をデータベースに保存します
db.refresh(db_todo): 更新後のデータを再取得します

🚀 動作確認

サーバーが起動していることを確認します:
Terminal window
```
uvicorn app.main:app --reload
```
ブラウザで http://localhost:8000/docs を開きます。
以下の操作を試してみましょう:
- Todoの更新（PUT /todos/{todo_id}）
```
{
  "title": "削除機能を作る"
}
```
- Todoの完了（PATCH /todos/{todo_id}/complete）

🎯 理解度チェック

以下の質問に答えて、学習内容を確認しましょう！

FastAPIでPUTリクエストを処理するエンドポイントを定義する際の正しい書き方は？
- A: @app.put("/todos/{todo_id}")
- B: @app.post("/todos/{todo_id}")
- C: @app.get("/todos/{todo_id}")

答えを見る

答え: A: @app.put("/todos/{todo_id}")

PUTはリソースの更新に使われるHTTPメソッドです
FastAPIでは@app.put()デコレータを使ってPUTリクエストを処理します
参考: FastAPI公式ドキュメント

📝 まとめ

このステップでは以下について学びました。

更新機能の作成
- 更新機能
- 部分更新機能