Django.Rest.Framework搭建测试
2016-09-28 16:54
274 查看
介绍
本教程主要介绍如何通过Django-Rest-Framework快速创建REST风格的API。为了快速的演示,本教程使用Django Framework内置的User和Group数据,并且使用sqlite数据库。
项目准备
创建一个名为 tutorial的Django项目,然后在创建一个名为quickstart的应用# 创建项目目录 mkdir tutorial cd tutorial # 为了环境的干净和稳定,建议创建一个虚拟的python运行环境,并关联本地的依赖 virtualenv env source env/bin/activate # 在windows环境使用 `env\Scripts\activate` #安装 Django 和 Django-Rest-Framework到虚拟环境中 pip install django pip install djangorestframework # 创建项目和应用 django-admin.py startproject tutorial . # 注意最后边的 "." 符号 cd tutorial django-admin.py startapp quickstart cd ..
接下来,我们同步相关的测试数据。(本教程为了降低环境的复杂性,默认使用sqlite数据)
python manage.py migrate
如果想修改对应的数据库,可以通过修改tutorial/settings.py中的DATABASES项来实现。具体可以参考Django Settings Ref
# tutorial/settings.py DATABASES = { 'default': { 'ENGINE': '数据库引擎', 'NAME': '数据库名称', 'USER': '用户名', 'PASSWORD': '密码', 'HOST': '数据库连接地址', 'PORT': '端口' } }
同步完测试数据以后,创建一个初始的用户(admin)和密码(password1234) 用来在接下来的场景中进行身份的校验
python manage.py createsuperuser
当我们完成数据库和用户的初始化工作后,接下来就可以进入到编码阶段了
序列化
接下来我们创建用于数据序列化的代码。创建 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. 你可以使用主键或者其他关系, 但使用HyperlinkedModelSerializer是一个好的 RESTful 设计
Views
我们最好写一些View。 打开 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
在django_rest_framework中, 所有常见的行为都被归到了ViewSets中. 当然我们可以将这些行为分拆出来, 但使用ViewSets, 使view的逻辑更为清楚.
路由
接下来我们配置API的路由规则,在文件 tutorial/urls.pyfrom django.conf.urls import url, include 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 = [ url(r'^', include(router.urls)), url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')) ]
因为我们使用的是viewset, 所以我们可以使用route class自动生成url conf.
设置
在完成以上工作以后,我们需要进行一些必要的全局设置。例如我们需要打开分页功能,以及我们希望API只能让admin用户访问等。诸如此类的设置都可以在tutorial/settings.py中完成INSTALLED_APPS = ( ... 'rest_framework', # 引入django-rest-framework ) REST_FRAMEWORK = { 'DEFAULT_PERMISSION_CLASSES': ('rest_framework.permissions.IsAdminUser',), 'PAGE_SIZE': 10 }
现在,我们完成了全部的工作。接下里开始测试
测试
至此我们的设置完成, 可以测试我们的REST API了, 首先启动django服务器:python manage.py runserver
至此我们可以访问我们的API
curl -H 'Accept: application/json; indent=4' -u admin:password1234 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" } ] }
参考:https://yq.aliyun.com/articles/58735
本篇中, 我们会创建一个简单的API, 用来查看和编辑django默认的user和group数据.
1. 设置
我们创建django项目tutorial, 和app quickstart:# 创建新Django项目 django-admin.py startproject tutorial cd tutorial # 使用virtualenvwrapper创建Virtualenv mkvirtualenv env workon env # 在env中安装Django 和 Django REST framework pip install django pip install djangorestframework # 创建新app python manage.py startapp quickstart
然后根据自己的数据库配置设置数据库:
# tutorial/settings.py DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': 'database_name', 'USER': 'database_user', 'PASSWORD': 'database_password', 'HOST': '', 'PORT': '' } } ... INSTALLED_APPS = ( ... 'quickstart', 'rest_framework', ) REST_FRAMEWORK = { 'DEFAULT_PERMISSION_CLASSES': ('rest_framework.permissions.IsAdminUser',), 'PAGINATE_BY': 10 }
最后通过syncdb创建数据库
python manage.py syncdb
2. 序列化
接下来我们创建用于数据序列化的代码:# 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. 你可以使用主键或者其他关系, 但使用HyperlinkedModelSerializer是一个好的 RESTful 设计.
3. Views
# 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): """ 允许查看和编辑user 的 API endpoint """ queryset = User.objects.all() serializer_class = UserSerializer class GroupViewSet(viewsets.ModelViewSet): """ 允许查看和编辑group的 API endpoint """ queryset = Group.objects.all() serializer_class = GroupSerializer
在django_rest_framework中, 所有常见的行为都被归到了ViewSets中. 当然我们可以将这些行为分拆出来, 但使用ViewSets, 使view的逻辑更为清楚.
使用queryset和serializer_class代替model变量, 使我们能更加好的控制API行为, 这也是我们推荐的使用方式.
4. URLs
# tutorial/urls.py from django.conf.urls import patterns, 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) # Wire up our API using automatic URL routing. # Additionally, we include login URLs for the browseable API. urlpatterns = patterns('', url(r'^', include(router.urls)), url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')) )
因为我们使用的是viewset, 所以我们可以使用route class自动生成url conf.
5. 测试
至此我们的设置完成, 可以测试我们的REST API了, 首先启动django服务器:python ./manage.py runserver
我们可以使用curl命令:
bash: curl -H 'Accept: application/json; indent=4' -u admin:password 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" } ] }
或者直接使用浏览器也可以:
参考: http://www.weiguda.com/blog/18/ http://www.tuicool.com/articles/zUbymyM
相关文章推荐
- Django REST framework笔记一之简易JsonAPI搭建(可使用)
- Django REST framework
- Django REST Framework Tutorial 3:基于类的Views(中文版教程)by hillfree
- Django-Rest-Framework 教程: 5. 提高关联性和超链接API
- 学习使用"Django REST framework"打造RESTful API接口——第一节 quickstart
- Django Rest Framework(一)
- djangorestframework安装
- django-rest-framework指南(1):序列化
- Django-Rest-Framework 教程: 6. ViewSets 和 Routers
- Django-Rest-Framework 教程: 3. 使用 class based views
- django rest framework Serializer
- Django REST Framework Tutorial 4:认证与权限(中文版教程)by hillfree
- tastypie Django REST framework
- Django REST framework(官方教程-六)
- Django-Rest-Framework 教程: 4. 验证和权限
- Django REST framework API
- Django REST framework
- django rest framework 入门2——Request and Response
- python 运行python manege.py runserver时报错:“no module named djangorestframework” 的解决方案
- django rest framework quickstart