Django REST Framework (DRF) 是一个建立在 Django 之上的 Web 框架,用于快速构建REST API。以下是一个简单的例子,展示了如何使用 DRF 创建一个简单的序列化器和视图。
首先,安装 Django REST Framework:
pip install djangorestframework
然后,在你的 Django 项目的 settings.py
文件中添加 rest_framework
到 INSTALLED_APPS
:
INSTALLED_APPS = [
# ...
'rest_framework',
]
现在,创建一个模型和序列化器:
# models.py
from django.db import models
class MyModel(models.Model):
name = models.CharField(max_length=100)
description = models.TextField()
# serializers.py
from rest_framework import serializers
from .models import MyModel
class MyModelSerializer(serializers.ModelSerializer):
class Meta:
model = MyModel
fields = '__all__'
最后,创建一个视图来处理 API 请求:
# views.py
from rest_framework import generics
from .models import MyModel
from .serializers import MyModelSerializer
class MyModelListCreate(generics.ListCreateAPIView):
queryset = MyModel.objects.all()
serializer_class = MyModelSerializer
class MyModelRetrieveUpdateDestroy(generics.RetrieveUpdateDestroyAPIView):
queryset = MyModel.objects.all()
serializer_class = MyModelSerializer
在 urls.py
中添加路由:
# urls.py
from django.urls import path
from .views import MyModelListCreate, MyModelRetrieveUpdateDestroy
urlpatterns = [
path('mymodel/', MyModelListCreate.as_view()),
path('mymodel/<int:pk>/', MyModelRetrieveUpdateDestroy.as_view()),
]
这个简单的例子展示了如何使用 DRF 创建一个处理 CRUD 操作的 REST API。这个框架还提供了许多其他功能,如权限控制、分页、过滤等,以满足不同应用的需求。