django rest framework media目录文件下载

一、项目开始
1.创建项目
mkdir tutorial
cd tutorial
2.创建一个虚拟环境来隔离本地的包依赖项
python3 -m venv env
source env/bin/activate #在Windows上使用’ env\Scripts\activate
3.在虚拟环境中安装Django和Django REST框架
pip install django
pip install djangorestframework
4.用一个应用程序建立一个新项目
django-admin startproject tutorial . # 注意结尾。'字符
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

应用程序是在项目目录中创建的，这可能看起来很不寻常。使用项目的名称空间可以避免与外部模块的名称冲突(这超出了快速入门的范围)。
5.现在第一次同步数据库
python manage.py migrate

6.我们还将创建一个名为admin的初始用户，其密码为admin。稍后，我们将在示例中验证该用户。
python manage.py createsuperuser --email [e-mail] --username admin

可视化工具查看：

二、序列化器
首先，我们将定义一些序列化器。让我们创建一个名为tutorial/quickstart/serializer .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

我们不是编写多个视图，而是将所有常见的行为分组到称为viewset的类中。如果需要的话，我们可以很容易地将它们分解成单独的视图，但是使用viewset可以使视图逻辑组织良好，并且非常简洁。

四、URLs

下面来连接API url。在教程/ 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'))
]

因为我们使用的是viewset而不是视图，所以我们可以为我们的API自动生成URL conf，只需将viewset注册到router类即可。同样，如果我们需要对API URL有更多的控制，我们可以简单地使用常规的基于类的视图，并显式地编写URL conf。最后，我们在browsable API中包含了默认的login和logout视图。这是可选的，但是如果您的API需要身份验证，并且希望使用browsable API，那么这是非常有用的。

五、分页
分页允许您控制每个页面返回多少对象。要启用它，请将以下行添加到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": "[e-mail]",
            "groups": [],
            "url": "http://127.0.0.1:8000/users/1/",
            "username": "admin"
        },
        {
            "email": "[e-mail]",
            "groups": [                ],
            "url": "http://127.0.0.1:8000/users/2/",
            "username": "tom"
        }
    ]
}