5: Todoの読み取り

このステップで学ぶこと

今回はTodoの読み取り(取得)機能を作成します。
APIを通じてデータベースからTodoを取得できるようにしましょう。

Todo取得機能の作成

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

todo-api/app/main.py

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")
def read_todos():
    return [
        {"id": 1, "title": "買い物に行く", "completed": False},
        {"id": 2, "title": "宿題をする", "completed": True}
    ]
# 1. 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

# 2. 特定の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.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

   • @app.get("/todos/"): GETリクエストを処理するエンドポイントを定義します
   • response_model=list[schemas.Todo]: レスポンスの形式を指定します
   • skipとlimit: ページネーション用のパラメータです
   • db.query(models.Todo): Todoテーブルに対するクエリを作成します
   • offset(skip).limit(limit): 指定された範囲のTodoを取得します
   • all(): クエリを実行して結果を取得します

2. 特定の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()
       if db_todo is None:
           raise HTTPException(status_code=404, detail="Todo not found")
       return db_todo

   • @app.get("/todos/{todo_id}"): パスパラメータを含むエンドポイントを定義します
   • todo_id: int: パスパラメータを整数型として受け取ります
   • filter(models.Todo.id == todo_id): 指定されたIDのTodoを検索します
   • first(): 最初の結果を取得します
   • HTTPException: エラーレスポンスを返します

🚀 動作確認

1. サーバーが起動していることを確認します:

   uvicorn app.main:app --reload

2. ブラウザで http://localhost:8000/docs を開きます。

3. 以下の操作を試してみましょう:

• Todoの一覧取得（GET /todos/）
• 特定のTodoの取得（GET /todos/{todo_id}）

🎯 理解度チェック

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

1. FastAPIでパスパラメータを定義する際の正しい書き方は？

   • A: @app.get("/todos/{todo_id}")
   • B: @app.get("/todos/:todo_id")
   • C: @app.get("/todos/todo_id")

答えを見る

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

• FastAPIでは、パスパラメータを{パラメータ名}の形式で定義します
• パラメータ名は関数の引数名と一致させる必要があります
• 参考: FastAPI公式ドキュメント

📝 まとめ

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

• 読み取り機能の作成
  • 一覧取得機能
  • 個別取得機能
  • パスパラメータの使い方
  • レスポンスモデルの指定方法

---