01.速览Django REST framework

作者：Bright Xu

我们将创建一个简单的API，以允许管理员用户查看和编辑系统中的用户和组。

项目设置

创建一个名为的新Django项目tutorial，然后启动一个名为的新应用quickstart。

# 创建项目文件夹
mkdir tutorial
cd tutorial

# 创建虚拟环境
python3 -m venv env
# 启动虚拟环境
source env/bin/activate  # 在 Windows系统里使用 `env\Scripts\activate`

# 在虚拟环境里安装 Django 和 Django REST framework
pip install django
pip install djangorestframework

# 创建一个Django项目
django-admin startproject tutorial .  # 注意后面有一个'.'号
cd tutorial
# 创建一个app
django-admin startapp quickstart
cd ..

项目布局应如下所示：

$ pwd
<some path>/tutorial
$ find .
.
./manage.py
./tutorial
./tutorial/__init__.py
./tutorial/quickstart
./tutorial/quickstart/__init__.py
./tutorial/quickstart/admin.py
./tutorial/quickstart/apps.py
./tutorial/quickstart/migrations
./tutorial/quickstart/migrations/__init__.py
./tutorial/quickstart/models.py
./tutorial/quickstart/tests.py
./tutorial/quickstart/views.py
./tutorial/settings.py
./tutorial/urls.py
./tutorial/wsgi.py

在项目目录中创建应用程序可能看起来很不正常。使用项目的名称空间可以避免与外部模块的名称冲突（该主题超出了快速入门的范围）。

现在，第一次同步数据库：

python manage.py migrate

我们还将创建一个初始用户admin，其密码为password123。在后面的示例中，我们将以该用户身份进行身份验证。

python manage.py createsuperuser --email admin@example.com --username admin

建立数据库并创建初始用户并准备好使用后，打开应用程序的目录，我们将进行编码…

序列化器 Serializers

首先，我们将定义一些Serializers序列化器。让我们新建一个文件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设计。

Views

好的，那我们最好写一些views。打开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。

如果需要，我们可以轻松地将它们分解为单个视图，但是使用视图集可以使视图逻辑组织得很好并且非常简洁。

URLs

好的，现在让我们连接API URL。继续tutorial/urls.py…

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)

# 使用自动URL路由连接我们的API。
# 此外，我们还包含了browsable API的登录url。
urlpatterns = [
    path('', include(router.urls)),
    path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

因为我们使用的是viewsets而不是views，所以我们只需为路由类注册viewsets即可自动为我们的API生成URL conf。

同样，如果我们需要对API URL的更多控制，我们可以简单地使用常规的基于类的views，并显式编写URL conf。

最后，我们包括用于可浏览API的默认登录和注销views。这是可选的，但在您的API需要身份验证并且您想使用可浏览的API时很有用。

分页

分页可让您控制每页返回多少个对象。要启用它，请将以下行添加到tutorial/settings.py

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 10
}

Settings

添加'rest_framework'到INSTALLED_APPS。设置模块将位于tutorial/settings.py

INSTALLED_APPS = [
    ...
    'rest_framework',
]

好的，我们完成了。

---

测试我们的API

现在，我们准备测试我们构建的API。让我们从命令行启动服务器。

python manage.py runserver

现在，我们可以使用诸如curl…之类的工具从命令行访问API 。

bash: curl -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/users/
{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "email": "admin@example.com",
            "groups": [],
            "url": "http://127.0.0.1:8000/users/1/",
            "username": "admin"
        },
        {
            "email": "tom@example.com",
            "groups": [                ],
            "url": "http://127.0.0.1:8000/users/2/",
            "username": "tom"
        }
    ]
}

或使用httpie命令行工具…

bash: http -a admin:password123 http://127.0.0.1:8000/users/

HTTP/1.1 200 OK
...
{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "email": "admin@example.com",
            "groups": [],
            "url": "http://localhost:8000/users/1/",
            "username": "paul"
        },
        {
            "email": "tom@example.com",
            "groups": [                ],
            "url": "http://127.0.0.1:8000/users/2/",
            "username": "tom"
        }
    ]
}

或直接通过浏览器访问URL http://127.0.0.1:8000/users/…

如果使用浏览器，请确保使用右上角的控件登录。

太好了，就是这么简单！

如果您想更深入地了解REST框架如何组合在一起，请继续阅读本教程，或者开始浏览API指南。