Django REST framework 的快速入门教程

CRM-API项目搭建

序列器（Serializers）

首先，我们来定义一些序列器。我们来创建一个新的模块（module）叫做 crm/rest_searializer.py ，这是我们用来描述数据是如何呈现的。

#从已存在的assets项目中导入数据models模块
from crm import models
from rest_framework import serializers

# Serializers定义了API的表现形式.
#显示超连接，继承serializers.HyperlinkedModelSerializer
#显示ID,继承ModelSerializer

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.UserProfile
        #假设你想去多层的数据可加参数,深度
        depth = 2
        fields = ('url', 'email', 'name', 'is_staff','is_active','role')
        #注意：你想访问role的对象（第三章表），你需要在定义一个类，将role的访问权限也给它
class RoleSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = models.UserProfile
        fields = ('name',)

需要注意的是，我们在这个案例中，使用了超链接关系（hyperlinked relations），借助的类是 HyperlinkedModelSerializer。你也可以使用主键（primary key）和其它一些关系型(relationships)，但超链接（hyperlinking）是非常好的RESTful设计。

视图（Views）

现在我们最好是写些视图。打开 crm/rest_view.py 然后打起你的键盘吧～

from crm import models
from rest_framework import viewsets
from crm import rest_searializer

# ViewSets 定义了 视图（view） 的行为.
class UserViewSet(viewsets.ModelViewSet):
    '''
    注意 以下两个字段名是固定的不可修改queryset，serializer_class
    '''
    queryset = models.UserProfile.objects.all()
    serializer_class = rest_searializer.UserSerializer


class RoleViewSet(viewsets.ModelViewSet):
    '''
    注意 以下两个字段名是固定的不可修改queryset，serializer_class
    '''
    queryset = models.Role.objects.all()
    serializer_class = rest_searializer.RoleSerializer

比起传统的做法，需要写很多视图，我们将所有的一般性行为（common behavior）组成一个 ViewSets 类。
如有需要，我们可很轻易的将其，拆分成数个单独的视图。但视图组（viewsets）能让视图的逻辑结构清晰，而且简洁。

URLs

写url，crm/urls.py

from crm import views
from rest_framework import routers
from crm.rest_view import UserViewSet,RoleViewSet
# Routers 提供了一种简单途径，自动地配置了URL。
router = routers.DefaultRouter()
router.register(r'users', UserViewSet)#需注册
router.register(r'roles', RoleViewSet)

# 使用自动的URL路由，让我们的API跑起来。
# 此外，我们也包括了登入可视化API的URLs。
urlpatterns = [
    url(r'^api/', include(router.urls)),
    #url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))#这个没写
]

因为我们用了视图组（viewsets）而不是多个视图，我们可以为我们的API自动的生成URL配置，只需简单的将视图组（viewsets）注册到router类中即可

同样的，如果我们需要对API URLs进行单独控制，我们可以使用普通基于类（class based）的视图，并详细的配置每个URL。

最后，我们为可视化API，添加登陆/登出视图。这是可选的，但对于需要登陆验证的API，以及可视化的API却是非常的有用。

Settings

我们也需要一些全局设置。我们想要分页（pagination），我们希望API只对管理用户开发。设置模块会在 crm/settings.py 中

INSTALLED_APPS = (
    ...
    'rest_framework',
)
#带分页
REST_FRAMEWORK = {
    'DEFAULT_PERMISSION_CLASSES': ('rest_framework.permissions.IsAdminUser',),
    'PAGE_SIZE': 10
}

#有关API相关的访问权限的问题
REST_FRAMEWORK = {
    # 使用Django的标准`django.contrib.auth`权限管理类,
    # 或者为尚未认证的用户，赋予只读权限.
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
    ]
}

测试

Django REST framework 的快速入门教程

view视图中调用接口

urls.py

urlpatterns = [
    url(r'api_test',views.api_test,name='api_test')
]

views.py

from crm import rest_searializer
def api_test(request):
    if request.method == "POST":
        data = json.loads(request.POST.get('data'))
        serializer_obj = rest_searializer.UserSerializer(data=data)
        if serializer_obj.is_valid():
            serializer_obj.save()
    return render(request,'crm/api_test.html',locals())

api_test.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>API测试</title>
</head>
<body>

<form action="" method="POST">{% csrf_token %}
    <textarea name="data"  ></textarea>
    <input type="submit">
</form>

{{ serializer_obj }}

</body>
</html>

本站文章如无特殊说明，均为本站原创，如若转载，请注明出处：Django REST framework 的快速入门教程 - Python技术站