Django REST Framework教程:快速入门

咱们将建立一个简单的容许管理员用户查看和编辑系统中的用户和组的API。

项目设置

利用pycharm建立一个名为 tutorial 的新django项目，并建立一个名为 quickstart 的新app。

 

目录结构

 

 

 

 在建立的虚拟环境中安装Django REST framework

pip install djangorestframework

查看安装的第三方库

 

 

 

如今第一次同步你的数据库：

python manage.py migrate

咱们还要建立一个名为 admin 的初始用户，密码为 public。咱们稍后将在该示例中验证该用户。

python manage.py createsuperuser

等你创建好一个数据库和初始用户，并准备好开始。打开应用程序的目录，咱们就要开始编码了...

 

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

Views

好了，咱们接下来再写一些视图。打开 tutorial/quickstart/views.py 文件开始写代码了。

 

 

 

from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from quickstart.serializers import UserSerializer, GroupSerializer


class UserViewSet(viewsets.ModelViewSet):
    """
    容许用户查看或编辑的API路径。
    """
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer


class GroupViewSet(viewsets.ModelViewSet):
    """
    容许组查看或编辑的API路径。
    """
    queryset = Group.objects.all()

再也不写多个视图，咱们将全部常见行为分组写到叫 ViewSets 的类中。

若是咱们须要，咱们能够轻松地将这些细节分解为单个视图，可是使用viewsets可使视图逻辑组织良好，而且很是简洁。

URLs

如今咱们在tutorial/urls.py中开始写链接API的URLs。

 

 

from django.conf.urls import url, include
from rest_framework import routers
from quickstart import views

router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'groups', views.GroupViewSet)

# 使用自动URL路由链接咱们的API。
# 另外，咱们还包括支持浏览器浏览API的登陆URL。
urlpatterns = [
    url(r'^', include(router.urls)),
    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

由于咱们使用的是viewsets而不是views，因此咱们能够经过简单地使用路由器类注册视图来自动生成API的URL conf。

再次，若是咱们须要对API URL进行更多的控制，咱们能够简单地将其拉出来使用常规基于类的视图，并明确地编写URL conf。

最后，咱们将包括用于支持浏览器浏览的API的默认登陆和注销视图。这是可选的，但若是您的API须要身份验证，而且你想要使用支持浏览器浏览的API，那么它们颇有用。

Settings

咱们也想设置一些全局设置。咱们想打开分页，咱们但愿咱们的API只能由管理员使用。设置模块都在 tutorial/settings.py 中。

INSTALLED_APPS = (
    ...
    'rest_framework',
)

REST_FRAMEWORK = {
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAdminUser',
    ],
    'PAGE_SIZE': 10
}

测试咱们的API

咱们如今能够测试咱们构建的API。咱们从命令行启动服务器。

python manage.py runserver

直接经过浏览器，转到URL http://127.0.0.1:8000/users/...

 

 detail": "Authentication credentials were not provided

没有提供身份验证凭据

 

点击右上login

 

 输入以前的用户名，密码进行登陆

 

 原文连接：https://www.django.cn/course/show-20.html

---

扫码关注微信公众号  “小樊Study”获取更多

 

直男们，扫我送女朋友哟！