Django REST框架 -1

项目设置

创建一个名为Django的新项目tutorial,然后启动一个新的应用程序quickstart

# Create the project directorymkdir tutorialcd tutorial
# Create a virtualenv to isolate our package dependencies locally

virtualenv envsource env/bin/activate      # On Windows use `env\Scripts\activate`

# Install Django and Django REST framework into the virtualenv
pip install django
pip install djangorestframework

# Set up a new project with a single application

django-admin.py startproject tutorial .    # Note the trailing ‘.‘ character 同级目录下cd tutorialdjango-admin.py startapp quickstartcd ..   #下级目录

现在第一次同步您的数据库:

python manage.py migrate

我们还将创建一个以admin密码命名的初始用户password123。我们稍后将在该示例中验证该用户。

python manage.py createsuperuser

一旦你设置了一个数据库,并且初始用户创建并准备好了,打开应用程序的目录,我们将得到编码...

串行器

首先我们要定义一些序列化程序。我们创建一个名为tutorial/quickstart/serializers.py我们将用于我们的数据表示的新模块。

from django.contrib.auth.models import User, Groupfrom rest_framework import serializers

class UserSerializer(serializers.HyperlinkedModelsSerializer):

class Meta:    model = User    fields = (‘url‘,‘username‘,‘email‘,‘groups‘)

class GroupSerializers(serializers.HyperlinkedModelsSerializer):    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, GroupSerializers

class UserViewSet(viewset.ModelViewSet):

  queryset = User.object.all().order_by(‘-date_joined‘)

  serializers_class = UserSerializer

class GroupViewSet(viewset.ModelsViewSet):

  queryset = Group.object.all()

  serializer_class = GroupSerializer

而不是写多个视图,我们将所有常见行为分组到被调用的类中ViewSets

如果我们需要,我们可以轻松地将这些细节分解为个人观点,但是使用视图可以使视图的逻辑很好地组织起来,并且非常简洁。

网址

好的,现在我们来连接API的URL。到tutorial/urls.py...

from django.conf.urls import url, include

from rest_framework import routers

from tutrial.quickstart import views

router = routers.DefalutRouter()

router.register(r‘user‘, views.UserViewSet)

router.register(r‘group‘,views.GroupViewSet)

urlpatterns = [

  url(r‘^‘, include(router.urls)),

  url(r‘^api-auth/‘,include(‘rest_framework.urls‘, namespace=‘rest_framework‘))

]

因为我们使用的是视图而不是视图,所以我们可以通过简单地使用路由器类注册该视图来自动生成API的URL conf。

再次,如果我们需要对API URL的更多控制,我们可以简单地将其下拉到使用常规的基于类的视图,并明确地编写URL conf。

最后,我们将包括默认登录和注销视图,以便与可浏览的API一起使用。这是可选的,但如果您的API需要身份验证,并且您想要使用可浏览的API,那么这是非常有用的。

设置

我们也想设置一些全局设置。我们想打开分页,我们希望我们的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

我们现在可以从命令行访问我们的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": "[email protected]",
            "groups": [],
            "url": "http://127.0.0.1:8000/users/1/",
            "username": "admin"
        },
        {
            "email": "[email protected]",
            "groups": [                ],
            "url": "http://127.0.0.1:8000/users/2/",
            "username": "tom"
        }
    ]
}

或使用httpie,命令行工具...

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": "[email protected]",
            "groups": [],
            "url": "http://localhost:8000/users/1/",
            "username": "paul"
        },
        {
            "email": "[email protected]",
            "groups": [                ],
            "url": "http://127.0.0.1:8000/users/2/",
            "username": "tom"
        }
    ]
}

或直接通过浏览器,转到URL http://127.0.0.1:8000/users/...

如果您正在使用浏览器,请确保使用右上角的控件进行登录。

 
 
时间: 09-19

Django REST框架 -1的相关文章

记Angular与Django REST框架的一次合作(2):前端组件化——Angular

注:这是这个系列的第二部分,主要集中在Angular的使用方面.之前使用过AngularJS(Angular 1.x),混在Django的模板中使用,这些页面一般完全是结果展示页.在有Django表单输入的页面中,就很难将两者很好的结合起来.自己在学习新版的Angular时,跟了2遍官方网站的“英雄指南”教程.第1次完全是照搬,熟悉了一下基本概念:第2次自己做了一些修改,写了一个图片分享系统(只有一个雏形,还不是特别完善). 推荐IDE:Visual Studio Code 代码: github

Django REST框架

安装 安装使用pip,包括您想要的任何可选包... pip install djangorestframework pip install markdown           # Markdown support for the browsable API. pip install django-filter        #  Filtering  support 添加 'rest_framework'  到你的 INSTALLED_APPS设置 INSTALLED_APPS = ( 're

Django REST框架 -序列化

建立一个新的环境 在我们做任何事情之前,我们将使用virtualenv创建一个新的虚拟环境.这将确保我们的包配置与我们正在开展的任何其他项目保持良好的隔离. virtualenv env source env/bin/activate 现在我们在一个virtualenv环境中,我们可以安装我们的包的要求. pip install django pip install djangorestframework pip install pygments # We'll be using this fo

接口测试随笔四之根据Django web框架进行接口测试

Django快速开发之投票系统 之前分享过一篇Django开发投票系统的例子.今天在这个例子上做一些延伸,来讲讲web接口的开发与测试. 开发投票系统接口                                                      虽然投票系统的的功能已经开发完成,但我们并没有开发专门的接口,在当前的投票系统中,在我们调用一个get或post请求时,系统会返回整个页面,并且把测试连同页面一起返回. 例如,当我们要调用所有问题的接口时(test_get.py) imp

Django messages框架

一.简介 在网页应用中,你经常需要在处理完表单或其它类型的用户输入后,显示一个通知消息(也叫做“flash message”)给用户 对于这个功能,Django 提供基于Cookie 和会话的消息,无论是匿名用户还是认证的用户. 其消息框架允许你临时将消息存储在请求中,并在接下来的请求(通常就是下一个请求)中提取它们并显示.每个消息都带有一个特定level 标签,表示其优先级(例如info.warning 或error) 二.启用消息框架 消息框架的实现通过一个中间件 类和对应的context

Django REST框架-请求与响应

用前面的那个文件,继续填写 教程2:请求和响应 从这一点开始,我们将真正开始覆盖REST框架的核心.我们来介绍几个基本的构建块. 请求对象 REST框架引入了Request扩展常规的对象HttpRequest,并提供了更灵活的请求解析.Request对象的核心功能是request.data属性,这与request.POST使用Web API 相似但更有用. request.POST # Only handles form data. Only works for 'POST' method. r

python开发学习-day15(前端部分知识、web框架、Django创建项目)

s12-20160430-day15 *:first-child { margin-top: 0 !important; } body>*:last-child { margin-bottom: 0 !important; } /* BLOCKS =============================================================================*/ p, blockquote, ul, ol, dl, table, pre { margin

web框架-----------------Django

python_web框架 ----------------MVC  ------------MTV 基于WSGI ----import WSGI moudle Django 自己实现socket  Tornado 自己实现WEB框架 自己实现web 基于WSGI写 Django eb框架 请求周期 处理用户请求 放置HTML模版 操作数据库 Controllers Views Modals Views Template Modals MVC/MTV Django => MTV 安装Django

RESTFull 的 Django

最近为了升级曾经用Django做的网站,决定升级修改下架构,而且在当今Rest风格API的架构正在一步步的渗透到各个公司的API设计中,那Django这个框架呢?当然也会例外. 现在现在以相对比较好用的rest framework做个demo: 环境:ubuntu, mysql, python, django, django-rest-framework 安装django (env)[email protected]:/usr/local$pip install django Downloadi