环境

Python 3.5.2
Django 2.0.6
djangorestframework 3.8.2
httpie 0.9.9

快速开始

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

项目设置

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

  1. # 创建项目目录
  2. mkdir tutorial
  3. cd tutorial
  5. # 创建 virtualenv 环境来隔离我们本地的包依赖关系
  6. virtualenv env
  7. source env/bin/activate  # 在 Windows 上使用 `env\Scripts\activate`
  9. # 在创建的虚拟环境中安装 Django 和 Django REST framework
  10. pip install django
  11. pip install djangorestframework
  13. # 创建一个新项目，并只有一个应用
  14. django-admin.py startproject tutorial .  # Note the trailing '.' character
  15. cd tutorial
  16. django-admin.py startapp quickstart
  17. cd ..

项目布局应该如下所示：

  1. (venv) fang@ubuntu:~/tutorial$ pwd
  2. /home/fang/tutorial
  3. (venv) fang@ubuntu:~/tutorial$ find .
  4. ...
  5. ./manage.py
  6. ./tutorial
  7. ./tutorial/urls.py
  8. ./tutorial/wsgi.py
  9. ./tutorial/settings.py
  10. ./tutorial/quickstart
  11. ./tutorial/quickstart/apps.py
  12. ./tutorial/quickstart/tests.py
  13. ./tutorial/quickstart/migrations
  14. ./tutorial/quickstart/migrations/__init__.py
  15. ./tutorial/quickstart/models.py
  16. ./tutorial/quickstart/admin.py
  17. ./tutorial/quickstart/views.py
  18. ./tutorial/quickstart/__init__.py
  19. ./tutorial/__init__.py

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

现在第一次同步您的数据库：

  1. (venv) fang@ubuntu:~/tutorial$ python manage.py migrate

我们还将创建一个名为 admin 的初始用户，其密码为 password123。稍后在示例中，我们将验证该用户。

  1. (venv) fang@ubuntu:~/tutorial$ python manage.py createsuperuser --email admin@example.com --username admin

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

序列化

首先我们要定义一些序列化器。我们来创建一个名为 tutorial/quickstart/serializers.py 的新模块，我们将用它来表示数据。

  1. from django.contrib.auth.models import User, Group
  2. from rest_framework import serializers
  5. class UserSerializer(serializers.HyperlinkedModelSerializer):
  6.     class Meta:
  7.         model = User
  8.         fields = ('url', 'username', 'email', 'groups')
  11. class GroupSerializer(serializers.HyperlinkedModelSerializer):
  12.     class Meta:
  13.         model = Group
  14.         fields = ('url', 'name')

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

视图

好了，我们最好写一些视图。打开 tutorial/quickstart/views.py 并输入。

  1. from django.contrib.auth.models import User, Group
  2. from rest_framework import viewsets
  3. from tutorial.quickstart.serializers import UserSerializer, GroupSerializer
  6. class UserViewSet(viewsets.ModelViewSet):
  7.     """
  8.     允许用户查看或编辑的 API 端点。
  9.     """
  10.     queryset = User.objects.all().order_by('-date_joined')
  11.     serializer_class = UserSerializer
  14. class GroupViewSet(viewsets.ModelViewSet):
  15.     """
  16.     允许组查看或编辑的 API 端点。
  17.     """
  18.     queryset = Group.objects.all()
  19.     serializer_class = GroupSerializer

我们将所有通用行为分组到 ViewSets 类中，而不是编写多个视图。

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

URLs

好的，现在让我们配置 API 的 URL。在 tutorial / urls.py 上…

  1. from django.conf.urls import url, include
  2. from rest_framework import routers
  4. from tutorial.quickstart import views
  6. router = routers.DefaultRouter()
  7. router.register(r'users', views.UserViewSet)
  8. router.register(r'group', views.GroupViewSet)
  10. # 使用自动 URL 路由连接 API。
  11. # 另外，我们还包括可浏览 API 的登录 URL。
  12. urlpatterns = [
  13.     url(r'^', include(router.urls)),
  14.     url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
  15. ]

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

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

最后，我们将包括默认的登录和注销视图，以用于可浏览的 API。这是可选的，但如果您的 API 需要身份验证并且您想使用可浏览的 API，则会很有用。

设置

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

  1. INSTALLED_APPS = [
  2.     'django.contrib.admin',
  3.     'django.contrib.auth',
  4.     'django.contrib.contenttypes',
  5.     'django.contrib.sessions',
  6.     'django.contrib.messages',
  7.     'django.contrib.staticfiles',
  8.     'rest_framework',
  9. ]

好的，我们完成了。

测试我们的 API

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

  1. $ python manage.py runserver

我们现在可以从命令行使用 curl 等工具访问我们的 API …

  1. (venv) fang@ubuntu:~/tutorial$ curl -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/users/
  2. [
  3.     {
  4.         "url": "http://127.0.0.1:8000/users/2/",
  5.         "username": "tom",
  6.         "email": "atom@example.com",
  7.         "groups": []
  8.     },
  9.     {
  10.         "url": "http://127.0.0.1:8000/users/1/",
  11.         "username": "admin",
  12.         "email": "admin@example.com",
  13.         "groups": []
  14.     }

或者命令行工具 httpie …

  1. (venv) fang@ubuntu:~/tutorial$ http -a admin:password123 http://127.0.0.1:8000/users/
  2. HTTP/1.1 200 OK
  3. Allow: GET, POST, HEAD, OPTIONS
  4. Content-Length: 198
  5. Content-Type: application/json
  6. Date: Mon, 25 Jun 2018 14:22:19 GMT
  7. Server: WSGIServer/0.2 CPython/3.5.2
  8. Vary: Accept, Cookie
  9. X-Frame-Options: SAMEORIGIN
  11. [
  12.     {
  13.         "email": "atom@example.com",
  14.         "groups": [],
  15.         "url": "http://127.0.0.1:8000/users/2/",
  16.         "username": "tom"
  17.     },
  18.     {
  19.         "email": "admin@example.com",
  20.         "groups": [],
  21.         "url": "http://127.0.0.1:8000/users/1/",
  22.         "username": "admin"
  23.     }
  24. ]

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

如果你正在使用浏览器访问，请确保从右上角的进行登录。

太棒了，那很容易！

如果您想更深入地了解 REST framework 是如何通过本教程组合在一起的，或者开始浏览 API 指南。