使用Django-Rest-Framework快速入门

介绍

本教程主要介绍如何通过Django-Rest-Framework快速创建REST风格的API。为了快速的演示，本教程使用Django Framework内置的User和Group数据，并且使用sqlite数据库。

项目准备

创建一个名为 tutorial的Django项目，然后在创建一个名为quickstart的应用

# 创建项目目录
mkdir tutorial
cd tutorial

# 为了环境的干净和稳定，建议创建一个虚拟的python运行环境，并关联本地的依赖
virtualenv env
source env/bin/activate  # 在windows环境使用 `env\Scripts\activate`

#安装 Django 和 Django-Rest-Framework到虚拟环境中
pip install django
pip install djangorestframework

# 创建项目和应用
django-admin.py startproject tutorial .  # 注意最后边的 "." 符号
cd tutorial
django-admin.py startapp quickstart
cd ..

接下来，我们同步相关的测试数据。(本教程为了降低环境的复杂性，默认使用sqlite数据)

python manage.py migrate

如果想修改对应的数据库，可以通过修改tutorial/settings.py中的DATABASES项来实现。具体可以参考Django Settings Ref

# tutorial/settings.py
    DATABASES = {
        'default': {
            'ENGINE': '数据库引擎',
            'NAME': '数据库名称',
            'USER': '用户名',
            'PASSWORD': '密码',
            'HOST': '数据库连接地址',
            'PORT': '端口'
        }
    }

同步完测试数据以后，创建一个初始的用户(admin)和密码(password1234) 用来在接下来的场景中进行身份的校验

python manage.py createsuperuser

当我们完成数据库和用户的初始化工作后，接下来就可以进入到编码阶段了

序列化

接下来我们创建用于数据序列化的代码。创建 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. 你可以使用主键或者其他关系, 但使用HyperlinkedModelSerializer是一个好的 RESTful 设计

Views

我们最好写一些View。 打开 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 endpoint that allows users to be viewed or edited.
    """
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer


class GroupViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows groups to be viewed or edited.
    """
    queryset = Group.objects.all()
    serializer_class = GroupSerializer

在django_rest_framework中, 所有常见的行为都被归到了ViewSets中. 当然我们可以将这些行为分拆出来, 但使用ViewSets, 使view的逻辑更为清楚.

路由

接下来我们配置API的路由规则，在文件 tutorial/urls.py

from django.conf.urls import url, include
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)

# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
    url(r'^', include(router.urls)),
    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

因为我们使用的是viewset, 所以我们可以使用route class自动生成url conf.

设置

在完成以上工作以后，我们需要进行一些必要的全局设置。例如我们需要打开分页功能，以及我们希望API只能让admin用户访问等。诸如此类的设置都可以在tutorial/settings.py中完成

INSTALLED_APPS = (
    ...
    'rest_framework',  # 引入django-rest-framework
)

REST_FRAMEWORK = {
    'DEFAULT_PERMISSION_CLASSES': ('rest_framework.permissions.IsAdminUser',),
    'PAGE_SIZE': 10
}

现在，我们完成了全部的工作。接下里开始测试

测试

至此我们的设置完成, 可以测试我们的REST API了, 首先启动django服务器:

python manage.py runserver

至此我们可以访问我们的API

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