Django REST Framework中文文档快速上手指南
项目地址: https://gitcode.com/gh_mirrors/dj/Django-REST-framework-documentation 还在为构建RESTful API而烦恼吗？Django REST Framework为你提供了一套优雅的解决方案。本文将通过实际操作演示如何快速搭建一个功能完整的API后端。
项目初始化与环境配置
首先创建一个名为tutorial的项目目录，并设置虚拟环境来隔离依赖包：
# 创建项目目录
mkdir tutorial
cd tutorial
# 创建虚拟环境
python3 -m venv env
source env/bin/activate
# 安装Django和Django REST Framework
pip install django
pip install djangorestframework
# 初始化项目结构
django-admin startproject tutorial .
cd tutorial
django-admin startapp quickstart
cd ..
完成上述步骤后，你的项目结构应该如下所示：
.
├── manage.py
├── tutorial
│ ├── __init__.py
│ ├── quickstart
│ │ ├── __init__.py
│ │ ├── admin.py
│ │ ├── apps.py
│ │ ├── migrations
│ │ │ └── __init__.py
│ │ ├── models.py
│ │ ├── tests.py
│ │ └── views.py
│ ├── settings.py
│ ├── urls.py
│ └── wsgi.py
数据库配置与用户创建
初始化数据库并创建管理员账户：
# 数据库迁移
python manage.py migrate
# 创建超级用户
python manage.py createsuperuser --email admin@example.com --username admin
核心组件构建
数据序列化器定义
在tutorial/quickstart/serializers.py中定义数据表示形式：
from django.contrib.auth.models import User, Group
from rest_framework import serializers
class UserSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = User
fields = ['url', 'username', 'email', 'groups']
class GroupSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = Group
fields = ['url', 'name']
这里我们使用了HyperlinkedModelSerializer来创建超链接关系，这是RESTful设计的良好实践。
视图逻辑实现
打开tutorial/quickstart/views.py编写视图逻辑：
from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from rest_framework import permissions
from tutorial.quickstart.serializers import UserSerializer, GroupSerializer
class UserViewSet(viewsets.ModelViewSet):
"""
允许查看和编辑用户的API端点
"""
queryset = User.objects.all().order_by('-date_joined')
serializer_class = UserSerializer
permission_classes = [permissions.IsAuthenticated]
class GroupViewSet(viewsets.ModelViewSet):
"""
允许查看和编辑用户组的API端点
"""
queryset = Group.objects.all()
serializer_class = GroupSerializer
permission_classes = [permissions.IsAuthenticated]
通过使用ViewSets，我们可以将多个视图的通用行为组织到类中，保持代码的整洁和简洁。
API路由配置
在tutorial/urls.py中配置API路由：
from django.urls import include, path
from rest_framework import routers
from tutorial.quickstart import views
router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'groups', views.GroupViewSet)
urlpatterns = [
path('', include(router.urls)),
path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
使用视图集和路由器，我们可以自动生成URL配置，大大简化了API的搭建过程。
分页与配置优化
在tutorial/settings.py中启用分页功能：
REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE': 10
}
别忘了将rest_framework添加到已安装应用列表中：
INSTALLED_APPS = [
...
'rest_framework',
]
API测试与验证
启动开发服务器并测试API功能：
python manage.py runserver
现在你可以通过多种方式访问你的API：
- 命令行工具如curl：
curl -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/users/
或者直接在浏览器中访问`http://127.0.0.1:8000/users/`，使用右上角的登录控件进行身份验证。
[](https://link.gitcode.com/i/984e91ec6493bf3f6718822b44205c92)
## 项目特色功能展示
Django REST Framework提供了丰富的功能组件，包括：
- **认证系统**：支持多种认证方式
- **权限控制**：细粒度的访问权限管理
- **序列化器**：强大的数据转换工具
- **视图集**：简化的视图逻辑组织
- **路由器**：自动化的URL配置
[](https://link.gitcode.com/i/984e91ec6493bf3f6718822b44205c92)
## 进阶学习路径
完成基础搭建后，你可以深入探索更多高级功能：
- 自定义序列化器字段
- 复杂的过滤和搜索功能
- 对象级权限控制
- API版本管理
通过这个快速入门指南，你已经成功搭建了一个功能完整的RESTful API。Django REST Framework的强大功能将帮助你在后续开发中事半功倍。创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
