安装 Django REST Framework

安装Django REST Framework（以下简称DRF）非常简单。您只需按照以下步骤操作：

创建一个新的Django项目或使用现有的Django项目。
在命令行中使用pip命令安装DRF。可以通过以下命令安装最新版本： Copy codepip install djangorestframework 或者，如果您想要安装特定版本，可以使用以下命令： Copy codepip install djangorestframework==3.12.4 这将安装版本号为3.12.4的DRF。
在项目的settings.py文件中添加DRF到INSTALLED_APPS中。 cssCopy codeINSTALLED_APPS = [ ... 'rest_framework',] 这将允许您使用DRF的所有功能。

现在您已经安装了DRF，接下来我们将介绍一些基本的用法和示例。

创建序列化器

序列化器是DRF中的一个核心概念。它们负责将Django模型转换为JSON、XML或其他格式的数据，并反之亦然。下面是一个简单的序列化器示例，用于将Django的User模型序列化为JSON格式：

代码语言：javascript复制

from rest_framework import serializers
from django.contrib.auth.models import User

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ['id', 'username', 'email']

在上面的示例中，我们从rest_framework导入序列化器类，并定义了一个名为UserSerializer的序列化器。我们指定了User模型作为序列化器的元数据，并指定了我们想要在JSON中包含的字段。

创建视图

视图是DRF中的另一个核心概念。它们定义了API的行为，即如何响应请求、如何验证输入等。下面是一个简单的视图示例，用于返回所有用户的列表：

代码语言：javascript复制

from rest_framework import generics
from django.contrib.auth.models import User
from .serializers import UserSerializer

class UserList(generics.ListAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer

在上面的示例中，我们从rest_framework导入generics视图，并定义了一个名为UserList的视图。我们指定了我们想要返回的所有用户的查询集，并指定了用于序列化数据的序列化器。

创建路由

路由是将URL映射到视图的一种机制。在DRF中，我们可以使用Django的URLConf和DRF的路由器来定义路由。下面是一个简单的路由器示例，用于将URL /users/ 映射到UserList视图：

代码语言：javascript复制

from django.urls import path
from .views import UserList

urlpatterns = [
    path('users/', UserList.as_view()),
]

在上面的示例中，我们定义了一个名为urlpatterns的列表，其中包含一个将/users/映射到UserList视图的路径。

测试API

现在我们已经定义了序列化器、视图和路由，我们可以使用Django内置的开发服务器测试我们的API。运行以下命令：

代码语言：javascript复制

python manage.py runserver

这将启动开发服务器。现在，您可以在浏览器中访问http://localhost:8000/users/，应该能够看到所有用户的JSON格式数据。

上面的示例只是DRF的入门示例。DRF有很多其他功能，例如身份验证、权限管理、限速、过滤、分页等等。您可以在DRF的官方文档中找到所有这些功能的详细信息。

django

0 人点赞