Django 4.2 LTS 搭配 Django REST Framework

### Django 4.2 LTS 中集成 Django REST Framework 的教程与最佳实践 在 Django 4.2 LTS 中集成 Django REST Framework (DRF) 是构建 RESTful API 的常见选择。以下是配置、集成和最佳实践的详细说明： #### 1. 安装 Django REST Framework 首先需要安装 Django REST Framework。可以通过 `pip` 安装该库[^1]： ```bash pip install djangorestframework ``` 接着，在 Django 项目的 `settings.py` 文件中，将 `'rest_framework'` 添加到 `INSTALLED_APPS` 列表中[^2]： ```python INSTALLED_APPS = [ # 其他应用 'rest_framework', ] ``` #### 2. 配置全局设置 在 `settings.py` 中可以定义一些全局配置，例如默认的渲染器、解析器和认证方式。以下是一个示例配置[^3]： ```python REST_FRAMEWORK = { 'DEFAULT_RENDERER_CLASSES': [ 'rest_framework.renderers.JSONRenderer', ], 'DEFAULT_PARSER_CLASSES': [ 'rest_framework.parsers.JSONParser', ], 'DEFAULT_AUTHENTICATION_CLASSES': [ 'rest_framework.authentication.SessionAuthentication', 'rest_framework.authentication.BasicAuthentication', ], 'DEFAULT_PERMISSION_CLASSES': [ 'rest_framework.permissions.IsAuthenticated', ], } ``` #### 3. 创建序列化器 序列化器是将模型实例转换为 JSON 或其他格式的核心组件。以下是一个简单的序列化器示例[^4]： ```python from rest_framework import serializers from myapp.models import MyModel class MyModelSerializer(serializers.ModelSerializer): class Meta: model = MyModel fields = '__all__' ``` #### 4. 创建视图 DRF 支持多种视图类型，包括基于函数的视图、基于类的视图以及通用视图。以下是一个使用通用视图的示例[^5]： ```python from rest_framework import generics from myapp.models import MyModel from myapp.serializers import MyModelSerializer class MyModelList(generics.ListCreateAPIView): queryset = MyModel.objects.all() serializer_class = MyModelSerializer class MyModelDetail(generics.RetrieveUpdateDestroyAPIView): queryset = MyModel.objects.all() serializer_class = MyModelSerializer ``` #### 5. 配置 URL 路由 通过 `urls.py` 文件定义 API 的路由规则。可以使用 DRF 提供的 `SimpleRouter` 来简化路由配置[^6]： ```python from django.urls import path, include from rest_framework.routers import SimpleRouter from myapp.views import MyModelList, MyModelDetail router = SimpleRouter() router.register(r'mymodel', MyModelViewSet) urlpatterns = [ path('api/', include(router.urls)), path('api/mymodel/', MyModelList.as_view(), name='mymodel-list'), path('api/mymodel/<int:pk>/', MyModelDetail.as_view(), name='mymodel-detail'), ] ``` #### 6. 最佳实践 - **安全性**：始终为 API 设置适当的认证和权限控制。推荐使用 JWT 或 OAuth2 进行身份验证[^7]。 - **分页**：对于大数据集，启用分页功能以提高性能[^8]。 - **文档生成**：使用 Swagger 或 Redoc 等工具自动生成 API 文档[^9]。 - **错误处理**：定义清晰的错误响应格式，确保客户端能够理解错误信息[^10]。 #### 示例代码 以下是一个完整的示例项目结构[^11]： ```plaintext myproject/ ├── manage.py ├── myproject/ │ ├── __init__.py │ ├── settings.py │ ├── urls.py │ └── wsgi.py └── myapp/ ├── __init__.py ├── admin.py ├── apps.py ├── models.py ├── serializers.py ├── views.py └── urls.py ``` ```python # serializers.py from rest_framework import serializers from myapp.models import MyModel class MyModelSerializer(serializers.ModelSerializer): class Meta: model = MyModel fields = '__all__' # views.py from rest_framework import generics from myapp.models import MyModel from myapp.serializers import MyModelSerializer class MyModelList(generics.ListCreateAPIView): queryset = MyModel.objects.all() serializer_class = MyModelSerializer class MyModelDetail(generics.RetrieveUpdateDestroyAPIView): queryset = MyModel.objects.all() serializer_class = MyModelSerializer # urls.py from django.urls import path from myapp.views import MyModelList, MyModelDetail urlpatterns = [ path('mymodel/', MyModelList.as_view(), name='mymodel-list'), path('mymodel/<int:pk>/', MyModelDetail.as_view(), name='mymodel-detail'), ] ```