Django REST Framework项目最佳实践

Django REST Framework（DRF）是构建高质量 Web API 的强大工具，但初学者常因项目结构混乱、配置冗余或缺乏规范而难以发挥其全部潜力。本文提供了一个小但完整的 DRF 示例项目，旨在展示现代 Django API 开发中推荐的组织方式与工程实践。

一、项目结构

最终项目目录结构如下：

myproject/ ├── venv/ # 虚拟环境 ├── requirements.txt # 依赖清单 ├── manage.py ├── myproject/ │ ├── __init__.py │ ├── settings.py │ ├── urls.py │ └── wsgi.py ├── myapp/ │ ├── __init__.py │ ├── models.py # 数据模型 │ ├── serializers.py # 序列化器 │ ├── views.py # 视图逻辑 │ ├── parsers.py # JSONL 解析函数 │ ├── urls.py # 应用路由 │ ├── tests.py # 单元测试 │ └── static/ # 本地图片（实际可能在云端） │ └── images/ │ ├── img1.jpg │ └── img2.png └── api.http # HTTP 接口测试文件

二、环境准备与依赖安装

1. 创建项目目录并进入

django-admin startproject myprojectcdmyproject

2. 创建虚拟环境

python -m venv venvsourcevenv/bin/activate# Linux/macOS# source venv\Scripts\activate # Windows bash

3. 安装依赖

创建requirements.txt文件：

Django==5.2 djangorestframework==3.16.0

安装：

pipinstall-r requirements.txt

4. 创建应用

python manage.py startapp myapp

三、配置

编辑myproject/settings.py：

frompathlibimportPath BASE_DIR=Path(__file__).resolve().parent.parent SECRET_KEY='django-insecure-z1*txrg&y@f^for5@+&8%3pq)^i&by!*riz9i=837=n(pdbyfh'DEBUG=TrueALLOWED_HOSTS=[]INSTALLED_APPS=['django.contrib.admin','django.contrib.auth','django.contrib.contenttypes','django.contrib.sessions','django.contrib.messages','django.contrib.staticfiles','myapp.apps.MyappConfig','rest_framework','rest_framework.authtoken',# 启用 Token 认证]MIDDLEWARE=['django.middleware.security.SecurityMiddleware','django.contrib.sessions.middleware.SessionMiddleware','django.middleware.common.CommonMiddleware','django.middleware.csrf.CsrfViewMiddleware','django.contrib.auth.middleware.AuthenticationMiddleware','django.contrib.messages.middleware.MessageMiddleware','django.middleware.clickjacking.XFrameOptionsMiddleware',]ROOT_URLCONF='myproject.urls'TEMPLATES=[{'BACKEND':'django.template.backends.django.DjangoTemplates','DIRS':[BASE_DIR/'templates'],'APP_DIRS':True,'OPTIONS':{'context_processors':['django.template.context_processors.request','django.contrib.auth.context_processors.auth','django.contrib.messages.context_processors.messages',],},},]WSGI_APPLICATION='myproject.wsgi.application'DATABASES={'default':{'ENGINE':'django.db.backends.sqlite3','NAME':BASE_DIR/'db.sqlite3',}}AUTH_PASSWORD_VALIDATORS=[{'NAME':'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',},{'NAME':'django.contrib.auth.password_validation.MinimumLengthValidator',},{'NAME':'django.contrib.auth.password_validation.CommonPasswordValidator',},{'NAME':'django.contrib.auth.password_validation.NumericPasswordValidator',},]LANGUAGE_CODE='en-us'TIME_ZONE='UTC'USE_I18N=TrueUSE_TZ=TrueSTATIC_URL='static/'# DRF 配置REST_FRAMEWORK={'DEFAULT_AUTHENTICATION_CLASSES':['rest_framework.authentication.TokenAuthentication',],'DEFAULT_PERMISSION_CLASSES':['rest_framework.permissions.IsAuth