🚀 快速開始

5 分鐘上手 AutoCRUD。

安裝

pip install autocrud

第一個 API

from datetime import datetime, timedelta
from fastapi import FastAPI
from fastapi.testclient import TestClient
from autocrud import AutoCRUD
from msgspec import Struct

class TodoItem(Struct):
    title: str
    completed: bool
    due: datetime

class TodoList(Struct):
    items: list[TodoItem]
    notes: str

# 創建 AutoCRUD
crud = AutoCRUD()
crud.add_model(TodoItem)
crud.add_model(TodoList)

app = FastAPI()
crud.apply(app)

測試 API

def test():
    client = TestClient(app)
    
    # 創建 TODO 清單
    resp = client.post("/todo-list", json={
        "items": [], 
        "notes": "我的待辦事項"
    })
    todo_list_id = resp.json()["resource_id"]
    
    # 使用 JSON Patch 添加項目
    resp = client.patch(f"/todo-list/{todo_list_id}", json=[{
        "op": "add",
        "path": "/items/-",
        "value": {
            "title": "Todo 1",
            "completed": False,
            "due": (datetime.now() + timedelta(hours=1)).isoformat(),
        },
    }])
    
    # 查看結果
    resp = client.get(f"/todo-list/{todo_list_id}/data")
    print(resp.json())
    
    # 標記完成
    resp = client.patch(f"/todo-list/{todo_list_id}", json=[
        {"op": "replace", "path": "/items/0/completed", "value": True}
    ])

if __name__ == "__main__":
    test()

支援的數據類型

msgspec.Struct (推薦)

from msgspec import Struct
class User(Struct):
    name: str
    age: int

dataclass

from dataclasses import dataclass
@dataclass
class User:
    name: str
    age: int

TypedDict

from typing import TypedDict
class User(TypedDict):
    name: str
    age: int

運行

# 默認 msgspec
python quick_start.py

# 其他類型
python quick_start.py dataclass
python quick_start.py typeddict

# 開發服務器
python -m fastapi dev quick_start.py

自動生成的端點

• POST /todo-item - 創建

• GET /todo-item/{id}/data - 讀取

• PATCH /todo-item/{id} - JSON Patch 更新

• DELETE /todo-item/{id} - 軟刪除

• GET /todo-list/full - 列表(含元數據)