翻译 Django REST framework 官方教程（1）quick start 快速开始

快速开始

我们将建立一个简单的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

我们同时建立一个初始用户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。你也可使用primary key和其他众多的关系，但是

超链接关系是一个好的RESTful 设计

Views

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

与其写许多views 函数，我们会把所有的相同行为合成对象（class）ViewSets.

有需要的话，我们可以简单的把它们分成独立的views。但是运用viewsets 能够使得view逻辑简约、有条理。

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)

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

因为我们使用的是viewsets 而不是views函数，我们可以为我们的API自动生成URL conf ，只要用router class登记viewsets 。

同样的，如果我们要对 API URLs有更多的控制，我们只需使用普通的class-based views并且明确的写出URL conf。

最后，我们包括了默认登入登出 views 来使得API可浏览。这是可选的，当你的API需要认证而且你想要使用可浏览的API的时候很有用。

Pagination（分页）

tutorial/settings.py

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

Settings

 tutorial/settings.py

将'rest_framework'加入INSTALLED_APPS

INSTALLED_APPS = (
    ...
    'rest_framework',
)

以上就完成了。

测试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/...

如果你使用的浏览器，请确认login使用了右上角的控制模块。