使用 FastAPI 建立 Todo API 的部分：逐步指南-Python教學-PHP中文網

使用 FastAPI 建立 Todo API 的部分：逐步指南

王林

發布： 2024-08-28 18:32:24

原創

286 人瀏覽過

Part Building a Todo API with FastAPI: Step-by-Step Guide

使用 FastAPI 建立 Todo API：逐步指南

程式碼可以在這裡找到：GitHub - jamesbmour/blog_tutorials：

一、簡介

在上一篇文章中，我們介紹了 FastAPI 並建立了基本的專案架構。現在，我們將更進一步，建立一個功能性的 Todo API。在本教程結束時，您將擁有一個可以建立、讀取、更新和刪除待辦事項的工作後端。

我們將涵蓋的內容：

設計 Todo 資料模型
實作CRUD操作
建立 API 端點
新增輸入驗證和錯誤處理
測試 API
重建與組織程式碼

二.設計 Todo 資料模型

為了管理待辦事項，我們必須定義一個表示待辦事項的資料模型。 FastAPI 使用 Pydantic 模型來驗證和解析數據，因此我們將在這裡利用它。

A. 定義 Todo 模式

我們將使用 Pydantic 建立兩個模型：

TodoCreate：用於建立或更新待辦事項時的輸入資料。
Todo：用於完整的待辦事項，包括 id 和created_at 等欄位。

from pydantic import BaseModel
from typing import Optional
from datetime import datetime

class TodoCreate(BaseModel):
    title: str
    description: Optional[str] = None
    completed: bool = False

class Todo(BaseModel):
    id: str
    title: str
    description: Optional[str] = None
    completed: bool
    created_at: datetime

登入後複製

B. 解釋字段

id：每個待辦事項的唯一識別碼。
標題：待辦事項的主要內容。
描述：其他詳細資訊（可選）。
已完成：待辦事項的布林狀態（無論是否完成）。
created_at：指示待辦事項建立時間的時間戳記。

三．為 Todos 建立 CRUD 操作

CRUD 代表建立、讀取、更新和刪除－管理資料的四個基本操作。在本教程中，我們將使用記憶體資料庫（一個簡單的列表）來實現這些操作。

A. 設定記憶體資料庫

我們將使用一個清單來儲存我們的待辦事項。為了簡單起見，我們還將添加一些範例待辦事項。

from uuid import uuid4
from datetime import datetime

todos = [
    {
        "id": str(uuid4()),
        "title": "Learn FastAPI",
        "description": "Go through the official FastAPI documentation and tutorials.",
        "completed": False,
        "created_at": datetime.now(),
    },
    {
        "id": str(uuid4()),
        "title": "Build a Todo API",
        "description": "Create a REST API for managing todo items using FastAPI.",
        "completed": False,
        "created_at": datetime.now(),
    },
    {
        "id": str(uuid4()),
        "title": "Write blog post",
        "description": "Draft a blog post about creating a Todo API with FastAPI.",
        "completed": False,
        "created_at": datetime.now(),
    },
]

登入後複製

B. 實作輔助函數

我們將實作一個簡單的輔助函數來透過 id 尋找待辦事項。

def get_todo_by_id(todo_id: str):
    for todo in todos:
        if todo["id"] == todo_id:
            return todo
    return None

登入後複製

四．實作 API 端點

A. 建立新的待辦事項

POST 端點允許使用者建立新的待辦事項。

@app.post("/todos/", response_model=Todo)
def create_todo(todo: TodoCreate):
    new_todo = Todo(
        id=str(uuid4()),
        title=todo.title,
        description=todo.description,
        completed=todo.completed,
        created_at=datetime.now()
    )
    todos.append(new_todo.dict())
    return new_todo

登入後複製

B. 檢索所有待辦事項

GET 端點從我們的記憶體資料庫中檢索所有待辦事項。

@app.get("/todos/", response_model=List[Todo])
def get_all_todos():
    return todos

登入後複製

C. 檢索單一待辦事項

GET 端點允許透過 ID 檢索單一待辦事項。

@app.get("/todos/{todo_id}", response_model=Todo)
def get_todo(todo_id: str):
    todo = get_todo_by_id(todo_id)
    if not todo:
        raise HTTPException(status_code=404, detail="Todo not found")
    return todo

登入後複製

D. 更新待辦事項

PUT 端點可讓使用者更新現有的待辦事項。

@app.put("/todos/{todo_id}", response_model=Todo)
def update_todo(todo_id: str, todo_data: TodoCreate):
    todo = get_todo_by_id(todo_id)
    if not todo:
        raise HTTPException(status_code=404, detail="Todo not found")
    todo["title"] = todo_data.title
    todo["description"] = todo_data.description
    todo["completed"] = todo_data.completed
    return Todo(**todo)

登入後複製

E. 刪除待辦事項

DELETE 端點允許使用者透過其 id 刪除待辦事項。

@app.delete("/todos/{todo_id}")
def delete_todo(todo_id: str):
    todo = get_todo_by_id(todo_id)
    if not todo:
        raise HTTPException(status_code=404, detail="Todo not found")
    todos.remove(todo)
    return {"detail": "Todo deleted successfully"}

登入後複製

V. 新增輸入驗證和錯誤處理

A. 使用 Pydantic 進行輸入驗證

FastAPI 會自動根據我們定義的 Pydantic 模型驗證輸入資料。這確保資料在處理之前符合我們預期的模式。

B. 自訂錯誤處理

我們可以透過新增異常處理程序來自訂錯誤回應。

@app.exception_handler(HTTPException)
def http_exception_handler(request, exc: HTTPException):
    return JSONResponse(
        status_code=exc.status_code,
        content={"detail": exc.detail},
    )

登入後複製