Django rest框架：快速开始

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

项目设置

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

# Create the project directory
mkdir tutorial
cd tutorial

# Create a virtualenv to isolate our package dependencies locally
virtualenv env
source env/bin/activate  # On Windows use `env\Scripts\activate`

# Install Django and Django REST framework into the virtualenv
pip install django
pip install djangorestframework

# Set up a new project with a single application
django-admin startproject tutorial .  # Note the trailing '.' character
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

我们还将创建一个名为adminpassword的初始用户password123。我们将在稍后的示例中以该用户身份进行身份验证。

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

一旦你建立了一个数据库并创建了初始用户并准备就绪，打开应用程序的目录，我们就会得到编码......

序列化

首先，我们将定义一些序列化器。让我们创建一个名为的新模块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设计。

视图

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

我们不是编写多个视图，而是将所有常见行为组合在一起调用ViewSets。

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

url路由

好的，现在让我们连接API URL。到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'))
]

因为我们使用视图集而不是视图，所以我们可以通过简单地将视图集注册到路由器类来自动为我们的API生成URL conf。

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

最后，我们将包含默认登录和注销视图，以便与可浏览API一起使用。这是可选的，但如果您的API需要身份验证并且您想要使用可浏览的API，则非常有用。

分页

分页允许您控制每页返回的对象数。要启用它，请添加以下行tutorial/settings.py

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

设置

添加'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/...

更多Django教程

学习更多Django教程