快速入门
我们将创建一个简单的 API，允许管理员用户查看和编辑系统中的用户和组。
项目设置
创建一个名为 tutorial 的新 Django 项目，然后启动一个名为 quickstart 的新应用。
# Create the project directory
mkdir tutorial
cd tutorial
# Create a virtual environment to isolate our package dependencies locally
python3 -m venv env
source env/bin/activate # On Windows use `env\Scripts\activate`
# Install Django and Django REST framework into the virtual environment
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 .
.
./tutorial
./tutorial/asgi.py
./tutorial/__init__.py
./tutorial/quickstart
./tutorial/quickstart/migrations
./tutorial/quickstart/migrations/__init__.py
./tutorial/quickstart/models.py
./tutorial/quickstart/__init__.py
./tutorial/quickstart/apps.py
./tutorial/quickstart/admin.py
./tutorial/quickstart/tests.py
./tutorial/quickstart/views.py
./tutorial/settings.py
./tutorial/urls.py
./tutorial/wsgi.py
./env
./env/...
./manage.py
应用程序在项目目录中创建可能看起来不寻常。使用项目的命名空间可以避免与外部模块的名称冲突（这是一个超出快速入门范围的话题）。
现在首次同步数据库
python manage.py migrate
我们还将创建一个名为 admin 的初始用户并设置密码。我们将在示例中以后以该用户身份进行身份验证。
python manage.py createsuperuser --username admin --email admin@example.com
一旦你设置了数据库并且初始用户已创建并准备就绪，请打开应用程序目录，我们将开始编码...
序列化器
首先，我们将定义一些序列化器。让我们创建一个名为 tutorial/quickstart/serializers.py 的新模块，我们将在其中使用数据表示。
from django.contrib.auth.models import Group, User
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 Group, User
from rest_framework import permissions, viewsets
from tutorial.quickstart.serializers import GroupSerializer, UserSerializer
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
permission_classes = [permissions.IsAuthenticated]
class GroupViewSet(viewsets.ModelViewSet):
"""
API endpoint that allows groups to be viewed or edited.
"""
queryset = Group.objects.all().order_by('name')
serializer_class = GroupSerializer
permission_classes = [permissions.IsAuthenticated]
我们不是编写多个视图，而是将所有常见行为分组到称为 ViewSets 的类中。
如果需要，我们可以轻松地将它们分解为各个视图，但使用视图集可以很好地组织视图逻辑，并且非常简洁。
URL
好的，现在让我们连接 API URL。进入 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'))
]
由于我们使用视图集而不是视图，因此我们可以通过简单地使用路由器类注册视图集来自动生成 API 的 URL 配置。
同样，如果我们需要对 API URL 进行更多控制，我们可以简单地使用基于类的常规视图，并显式编写 URL 配置。
最后，我们包括用于可浏览 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 -u admin -H 'Accept: application/json; indent=4' http://127.0.0.1:8000/users/
Enter host password for user 'admin':
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"url": "http://127.0.0.1:8000/users/1/",
"username": "admin",
"email": "admin@example.com",
"groups": []
}
]
}
或使用 httpie 命令行工具...
bash: http -a admin http://127.0.0.1:8000/users/
http: password for admin@127.0.0.1:8000::
$HTTP/1.1 200 OK
...
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"email": "admin@example.com",
"groups": [],
"url": "http://127.0.0.1:8000/users/1/",
"username": "admin"
}
]
}
或通过直接访问 URL http://127.0.0.1:8000/users/ 访问浏览器...
如果你正在使用浏览器，请务必使用右上角的控件登录。
太棒了，太简单了！