Django REST API — 项目 CLAUDE.md¶

使用 PostgreSQL 和 Celery 的 Django REST Framework API 实际项目示例。请将其复制到项目根目录，并根据服务进行自定义。

项目概览¶

技术栈: Python 3.12+, Django 5.x, Django REST Framework, PostgreSQL, Celery + Redis, pytest, Docker Compose

架构: 按业务领域划分应用的领域驱动设计。API 层使用 DRF，异步任务使用 Celery，测试使用 pytest。所有端点都返回 JSON — 无模板渲染。

重要规则¶

Python 规范¶

为所有函数签名添加类型提示 — 使用 from __future__ import annotations
不使用 print() 语句 — 使用 logging.getLogger(__name__)
字符串格式化使用 f-string，不使用 % 或 .format()
文件操作使用 pathlib.Path，而不是 os.path
使用 isort 排序导入：标准库、第三方、本地（由 ruff 强制）

数据库¶

所有查询使用 Django ORM — 原生 SQL 仅限 .raw() 和参数化查询
迁移必须提交到 git — 生产环境绝对不要使用 --fake
使用 select_related() 和 prefetch_related() 防止 N+1 查询
所有模型都需要 created_at 和 updated_at 自动字段
为在 filter()、order_by() 或 WHERE 子句中使用的字段添加索引

# 悪い例: N+1クエリ
orders = Order.objects.all()
for order in orders:
    print(order.customer.name)  # 各注文ごとにDBをヒット

# 良い例: JOINによる単一クエリ
orders = Order.objects.select_related("customer").all()

认证¶

使用 djangorestframework-simplejwt 实现 JWT — 访问令牌（15 分钟）+ 刷新令牌（7 天）
为所有视图设置权限类 — 不要依赖默认值
以 IsAuthenticated 为基础，并为对象级访问添加自定义权限
启用用于登出的令牌黑名单

序列化器¶

简单 CRUD 使用 ModelSerializer，复杂验证使用 Serializer
如果输入和输出形状不同，则分离读取和写入序列化器
验证应在序列化器层进行，而不是在视图中 — 视图应保持薄

class CreateOrderSerializer(serializers.Serializer):
    product_id = serializers.UUIDField()
    quantity = serializers.IntegerField(min_value=1, max_value=100)

    def validate_product_id(self, value):
        if not Product.objects.filter(id=value, active=True).exists():
            raise serializers.ValidationError("Product not found or inactive")
        return value

class OrderDetailSerializer(serializers.ModelSerializer):
    customer = CustomerSerializer(read_only=True)
    product = ProductSerializer(read_only=True)

    class Meta:
        model = Order
        fields = ["id", "customer", "product", "quantity", "total", "status", "created_at"]

错误处理¶

使用 DRF 异常处理器实现一致的错误响应
在 core/exceptions.py 中定义业务逻辑的自定义异常
不要向客户端公开内部错误详情

# core/exceptions.py
from rest_framework.exceptions import APIException

class InsufficientStockError(APIException):
    status_code = 409
    default_detail = "Insufficient stock for this order"
    default_code = "insufficient_stock"

代码风格¶

不要在代码或注释中使用表情符号
最大行长度：120 字符（由 ruff 强制）
类：PascalCase，函数/变量：snake_case，常量：UPPER_SNAKE_CASE
视图应保持薄 — 业务逻辑放在服务函数或模型方法中

文件结构¶

config/
  settings/
    base.py              # 共通設定
    local.py             # 開発用オーバーライド（DEBUG=True）
    production.py        # 本番設定
  urls.py                # ルートURL設定
  celery.py              # Celeryアプリ設定
apps/
  accounts/              # ユーザー認証、登録、プロフィール
    models.py
    serializers.py
    views.py
    services.py          # ビジネスロジック
    tests/
      test_views.py
      test_services.py
      factories.py       # Factory Boy ファクトリー
  orders/                # 注文管理
    models.py
    serializers.py
    views.py
    services.py
    tasks.py             # Celeryタスク
    tests/
  products/              # 商品カタログ
    models.py
    serializers.py
    views.py
    tests/
core/
  exceptions.py          # カスタムAPI例外
  permissions.py         # 共有パーミッションクラス
  pagination.py          # カスタムページネーション
  middleware.py          # リクエストロギング、タイミング
  tests/

主要模式¶

服务层¶

# apps/orders/services.py
from django.db import transaction

def create_order(*, customer, product_id: uuid.UUID, quantity: int) -> Order:
    """在庫バリデーションと支払い保留付きで注文を作成する。"""
    product = Product.objects.select_for_update().get(id=product_id)

    if product.stock < quantity:
        raise InsufficientStockError()

    with transaction.atomic():
        order = Order.objects.create(
            customer=customer,
            product=product,
            quantity=quantity,
            total=product.price * quantity,
        )
        product.stock -= quantity
        product.save(update_fields=["stock", "updated_at"])

    # 非同期: 確認メールを送信
    send_order_confirmation.delay(order.id)
    return order

视图模式¶

# apps/orders/views.py
class OrderViewSet(viewsets.ModelViewSet):
    permission_classes = [IsAuthenticated]
    pagination_class = StandardPagination

    def get_serializer_class(self):
        if self.action == "create":
            return CreateOrderSerializer
        return OrderDetailSerializer

    def get_queryset(self):
        return (
            Order.objects
            .filter(customer=self.request.user)
            .select_related("product", "customer")
            .order_by("-created_at")
        )

    def perform_create(self, serializer):
        order = create_order(
            customer=self.request.user,
            product_id=serializer.validated_data["product_id"],
            quantity=serializer.validated_data["quantity"],
        )
        serializer.instance = order

测试模式（pytest + Factory Boy）¶

# apps/orders/tests/factories.py
import factory
from apps.accounts.tests.factories import UserFactory
from apps.products.tests.factories import ProductFactory

class OrderFactory(factory.django.DjangoModelFactory):
    class Meta:
        model = "orders.Order"

    customer = factory.SubFactory(UserFactory)
    product = factory.SubFactory(ProductFactory, stock=100)
    quantity = 1
    total = factory.LazyAttribute(lambda o: o.product.price * o.quantity)

# apps/orders/tests/test_views.py
import pytest
from rest_framework.test import APIClient

@pytest.mark.django_db
class TestCreateOrder:
    def setup_method(self):
        self.client = APIClient()
        self.user = UserFactory()
        self.client.force_authenticate(self.user)

    def test_create_order_success(self):
        product = ProductFactory(price=29_99, stock=10)
        response = self.client.post("/api/orders/", {
            "product_id": str(product.id),
            "quantity": 2,
        })
        assert response.status_code == 201
        assert response.data["total"] == 59_98

    def test_create_order_insufficient_stock(self):
        product = ProductFactory(stock=0)
        response = self.client.post("/api/orders/", {
            "product_id": str(product.id),
            "quantity": 1,
        })
        assert response.status_code == 409

    def test_create_order_unauthenticated(self):
        self.client.force_authenticate(None)
        response = self.client.post("/api/orders/", {})
        assert response.status_code == 401

环境变量¶

# Django
SECRET_KEY=
DEBUG=False
ALLOWED_HOSTS=api.example.com

# データベース
DATABASE_URL=postgres://user:pass@localhost:5432/myapp

# Redis（Celeryブローカー + キャッシュ）
REDIS_URL=redis://localhost:6379/0

# JWT
JWT_ACCESS_TOKEN_LIFETIME=15       # 分
JWT_REFRESH_TOKEN_LIFETIME=10080   # 分（7日）

# メール
EMAIL_BACKEND=django.core.mail.backends.smtp.EmailBackend
EMAIL_HOST=smtp.example.com

测试策略¶

# すべてのテストを実行
pytest --cov=apps --cov-report=term-missing

# 特定のアプリのテストを実行
pytest apps/orders/tests/ -v

# 並列実行で実行
pytest -n auto

# 前回の失敗したテストのみ
pytest --lf

ECC工作流¶

# 計画
/plan "Add order refund system with Stripe integration"

# TDDによる開発
/tdd                    # pytest ベースのTDDワークフロー

# レビュー
/python-review          # Python固有のコードレビュー
/security-scan          # Djangoセキュリティ監査
/code-review            # 全般的な品質チェック

# 検証
/verify                 # ビルド、リント、テスト、セキュリティスキャン

Git 工作流¶

feat: 新功能、fix: 修复缺陷、refactor: 代码重构
从 main 创建功能分支，并需要提交 PR
CI: ruff（Lint + 格式化）、mypy（类型检查）、pytest（测试）、safety（依赖项检查）
部署：通过 Kubernetes 或 Railway 管理 Docker 镜像

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 ev/ECC