Django rest_framework 快速开始

Django rest_framework 快速开始

如果您想更深入地了解REST框架是如何组合在一起的，请参阅我的另一篇博客Django REST framework
简介与中文教程；

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

项目搭建

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

# 创建项目目录
mkdir tutorial
cd tutorial

# 创建一个虚拟环境来隔离本地的依赖包
virtualenv env
source env/bin/activate # 在 Windows 中使用 'env/Scripts/activate' 命令激活虚拟环境

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

# 创建一个新的项目程序
django-admin startproject tutorial 
cd tutorial
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（序列化器）

首先，我们将定义一些序列化器；让我们创建一个名为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(serializer.HyperlinkedModelSerializer):
	class Meta:
		model = Group
		fields = ('url', 'name')

注意：在本例中，我们使用的是HyperlinkedModelSerializer的超链接关系；您还可以使用主键和其他各种关系，但是超链接是一种很好的RESTful设计。

Views（视图）

OK，我们现在写一些视图；打开tutorial/quickstart/views.py，然后输入：

from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from tutorial.quickstart.serializers import UserSerializer, GroupSerializer


class UserViewSet(viewsets.ModelViewSet):
    """
    允许用户查看或编辑的API端点。
    """
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer


class GroupViewSet(viewsets.ModelViewSet):
    """
    允许查看或编辑组的API端点。
    """
    queryset = Group.objects.all()
    serializer_class = GroupSerializer

我们没有编写多个视图，而是将所有常见的行为分组到称为ViewSets的类中。

如果需要的话，我们可以很容易地将这些视图分解为单独的视图，但是使用viewsets可以很好地组织视图逻辑，并且非常简洁。

URLs

OK，现在让我们连接API URLs；在教程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。
# 此外，我们还包含了可浏览API的登录URL。
urlpatterns = [
    path('', include(router.urls)),
    path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

因为我们使用的是视图集而不是视图，所以我们可以为API自动生成URL conf，只需将视图集注册到router类即可。

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

最后，我们在可浏览API中包含了默认的login和logout视图；这是可选的，但是如果您的API需要身份验证，并且您希望使用可浏览的API，那么这是非常有用的。

Pagination（分页）

分页允许您控制每页返回多少对象；要启用它，请将以下行添加到tutorial/settings.py中：

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

Settings（设置）

设置模块在tutorial/settings.py中，在设置模块的INSTALLED_APPS中添加rest_framework；

INSTALLED_APPS = (
	...
	'rest_framework',
)

OK，我们已经完成了。

---

测试我们的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/…

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

OK！

如果您想更深入地了解REST框架是如何组合在一起的，请参阅我的另一篇博客Django REST framework
简介与中文教程；