如何使用Django REST framework

# 如何使用Django REST framework

## 概述

Django REST framework（简称DRF）是构建Web API的强大工具包，基于Django框架开发。它提供了序列化、视图、认证等组件，能快速构建符合RESTful规范的API接口。本文将介绍DRF的核心功能和使用方法。

## 安装与配置

### 1. 安装依赖
```bash
pip install django djangorestframework

2. 添加应用到INSTALLED_APPS

# settings.py
INSTALLED_APPS = [
    ...
    'rest_framework',
]

3. 配置全局设置（可选）

# settings.py
REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 20
}

核心组件

1. 序列化（Serializers）

序列化器将模型实例转换为JSON等格式：

from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = ['id', 'title', 'author', 'published_date']

2. 视图（Views）

DRF提供多种视图类：

• APIView：基础视图类
• GenericAPIView：通用视图基类
• ViewSet：组合了多个动作的视图

示例：

from rest_framework.views import APIView
from rest_framework.response import Response
from .models import Book
from .serializers import BookSerializer

class BookList(APIView):
    def get(self, request):
        books = Book.objects.all()
        serializer = BookSerializer(books, many=True)
        return Response(serializer.data)

3. 路由（Routers）

自动生成URL路由：

from rest_framework.routers import DefaultRouter
from .views import BookViewSet

router = DefaultRouter()
router.register(r'books', BookViewSet)

urlpatterns = router.urls

完整API示例

1. 创建模型

# models.py
from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=100)
    published_date = models.DateField()

2. 创建序列化器

# serializers.py
from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'

3. 创建视图集

# views.py
from rest_framework import viewsets
from .models import Book
from .serializers import BookSerializer

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

4. 配置URL

# urls.py
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import BookViewSet

router = DefaultRouter()
router.register(r'books', BookViewSet)

urlpatterns = [
    path('api/', include(router.urls)),
]

高级功能

1. 认证与权限

DRF提供多种认证方式： - Token认证 - Session认证 - JWT认证（需安装djangorestframework-simplejwt）

示例配置：

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework.authentication.TokenAuthentication',
    ],
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAuthenticated',
    ]
}

2. 过滤与搜索

使用django-filter实现高级过滤：

from django_filters.rest_framework import DjangoFilterBackend

class BookViewSet(viewsets.ModelViewSet):
    filter_backends = [DjangoFilterBackend]
    filterset_fields = ['author', 'published_date']

3. 分页

配置分页方式：

class BookViewSet(viewsets.ModelViewSet):
    pagination_class = PageNumberPagination
    page_size = 10

最佳实践

1. 保持API简洁：避免返回过多不必要的数据
2. 使用版本控制：通过URL或请求头实现API版本管理
3. 文档化API：使用DRF的自动文档功能或Swagger
4. 性能优化：使用select_related和prefetch_related减少查询次数
5. 测试API：编写自动化测试用例

总结

Django REST framework通过提供丰富的组件和工具，大大简化了API开发流程。从简单的CRUD操作到复杂的业务逻辑，DRF都能提供优雅的解决方案。掌握DRF将显著提升你的后端开发效率。

”`

（注：实际字数为约850字，可根据需要扩展具体章节内容）