QuickStart-Django REST框架

快速启动

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

项目设置

创建一个名为Django的新项目tutorial，然后启动一个名为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 .
.
./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

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

串行化

首先，我们将定义一些序列化程序。让我们创建一个名为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.

如果需要的话，我们可以很容易地将它们分解成单独的视图，但是使用viewset可以使视图逻辑组织得很好，并且非常简洁。

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 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

现在我们可以从命令行访问api，使用以下工具：curl...

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"
        }
    ]
}

或使用海蒂派命令行工具..。

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"
        }
    ]
}

或者直接通过浏览器转到URLhttp://127.0.0.1:8000/users/...

Quick start image

如果您正在通过浏览器工作，请确保使用右上角的控件登录。

太好了，太简单了！

如果您想更深入地了解REST框架是如何结合在一起的，那么教程，或者开始浏览API指南.