Django.Rest.Framework搭建测试

最新推荐文章于 2024-07-21 13:22:07 发布
最新推荐文章于 2024-07-21 13:22:07 发布
阅读量1.6k 收藏 1
点赞数 1


介绍

本教程主要介绍如何通过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.py

from 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之Restful接口测试-Django自带测试模块(七)
美味的世界
04-27 3030
Django自带测试模块 上章博客写的Restful接口测试使用的是python里的Unittest测试框架，而本章使用Django自带的测试模块。 Django的单元测试使用python的unittest模块，这个模块使用基于类的方法来定义测试。类名为django.test.TestCase,继承于python的unittest.TestCase。 项目的目录结构： |-- Django_St...
Django-REST-framework教程中文版
09-12
本教程基于Django1.9以及restframework-v3.3.3版本，着重介绍了序列化、请求和响应处理、类视图、认证和权限、关联关系及超链接处理以及ViewSets和Routers的使用。 首先，在快速入门章节中，教程引导我们如何搭建一...
rest_framework框架的认识
weixin_30938149的博客
07-04 801
rest_framework框架的认识 　　它是基于Django的，帮助我们快速开发符合RESTful规范的接口框架。 一 路由 　　可以通过路由as_view()传参 根据请求方式的不同执行对应不同的方法 　　在routers模块下 封装了很多关于路由的方法 ， 最基础的BaseRouter类，给我提供自定制的接口。 　　下面这个方法给我们提...
深入理解Django REST framework (DRF)：从安装到API测试
最新发布
qq_64469885的博客
07-21 520
在本篇博客中，将带领你深入了解如何使用Django REST framework（DRF）来构建一个RESTful API。我们将从安装必需的库开始，逐步深入到模型定义、视图创建、路由设置，直至API的运行和测试。
Django-restframework34 Testing（测试）
runnoob_1115的博客
11-12 2125
一Testing 二APIRequestFactory 创建一个测试请求 强制认证 强制进行CSRF验证 三APIClient 制造请求 认证Authenticating CSRF validation 四RequestsClient请求客户端 五CoreAPIClient 没有经过测试的代码是垃圾代码 一、TestingREST框架包含一些用于扩展Django的测试框架的类，改进对API请求的支
Django+RestFramework实现API接口及接口文档并返回json数据
AdeCary的博客
01-29 6629
系统：ubuntu18.04 x64 GitHub：https://github.com/xingjidemimi/DjangoAPI.git 安装 pip install django==2.1.5 pip install djangorestframework # rest api pip install coreapi pygments markdown # 自动化接口文档 API示例 ...
django RestFrameWork的简单测试
麻烦处...
02-26 454
描述 写道 在icgoo中添加restframework，以订单模型Order做为资源制定接口主要参考官方提供的接口例子：BlogPosts   官方例子：http://django-rest-framework.org/examples/blogpost.html   操作 settings中INSTALLED_APPS加入：   'django.contrib.st...
Vue+Django REST framework 打造生鲜电商项目.docx
09-26
Vue+Django REST framework 打造生鲜电商项目 Vue 和 Django REST framework 是当前非常流行的前端和后端技术栈，本文档旨在指导读者使用 Vue 和 Django REST framework 联合开发一个完整的生鲜电商项目。 1. 项目...
Django REST framework 中文文档.pdf
05-16
Django REST framework（DRF）是建立在Django Web框架之上的一款强大的、灵活的并且能够处理Web API的工具集。DRF为开发者提供了一套快速构建RESTful API的解决方案，它不仅能够帮助开发者避免重复的代码编写，还...
利用rest framework搭建Django API过程解析
09-18
总结来说，使用Django REST framework搭建API主要包括以下步骤： 1. 安装`djangorestframework`。 2. 在`settings.py`中配置REST framework。 3. 创建序列化类以处理数据的序列化和反序列化。 4. 创建视图集，用于...
API测试新高度：django.test.client与Django REST framework的完美集成
[API测试新高度：django.test.client与Django REST framework的完美集成](https://www.delftstack.com/img/Django/ag feature image - django create json response.png) # 1. API测试的理论基础 API（Application ...
Django + Django REST framework步骤总结
weixin_34095889的博客
11-25 1115
主要记录一下Django + Django REST framework的步骤总结，第一次鼓捣后台和python，代码写得可能有点乱此demo项目的部署记录点击这里 一、创建配置项目 项目初始配置 创建项目 $django-admin startproject mysite 安装数据库驱动 $pip install pymysql 更改数...
Django之REST Framework框架介绍
weixin_47454485的博客
07-14 409
一、基本介绍 它是在Django原生代码的基础上进行了二次开发，主要用于构建Restful API，简称为DRF框架或者REST Framework框架 二、特性 提供了的Serializer序列化器，可以高效地进行序列化与反序列化（输入输出）操作 提供了丰富的类视图、Mixin扩展类、Viewset视图集 提供了直观的Web API界面 多种身份认证和权限认证 强大的排序、过滤、分页、搜索、限流等功能 可扩展性强，插件丰富 三、安装&配置 1.安装 直接使用pip安装即可 pip install
Restframework介绍
daruan1111的博客
07-31 521
1.REST介绍 　　REST与技术无关，它代表的是一种软件架构风格，全称Representational State Transfer，中文翻译为“表征状态转移” 　　REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态 1.1.RESTful API设计 　　当前发展前端设...
RESTframework_一
WEi的博客
06-27 1586
RESTframework Web应用模式 前后端不分离 过程: 浏览器请求动态页面 –> 后端服务器响应(查询数据库,渲染模板) 前端页面看到的效果都是由后端控制,后端渲染页面或重定向 后端控制前端的展示,前端后端的耦合性很高. 这种应用模式只适用于纯网页应用,当后端对接APP时,App可能不需要后端网页,而只是需要数据,所有不适用,需要重新开发接口. 前后端分离...
Rest Framework
chexiansheng的博客
04-16 1016
４
rest framework
weixin_30852367的博客
05-22 212
一，Requests：请求 request.user：请求身份验证的用户， AnonymousUser:游客 request.auth：请求通过身份验证的令牌实例 request.data：返回请求主体的解析内容 request.method: 返回请求的HTTP方法的大写字符串表示形式。 request.content_type: 返回表示HTTP请求正文的媒体类型的字符串对象，如果没...
Django Rest_Framework(DRF)
m0_61810345的博客
02-26 2002
Django REST framework中的Serializer使用类来定义，必须直接或间接继承于rest_framework.serializers.Serializer。rest_framework.serializers 是drf提供给开发者调用的序列化器模块里面声明了所有的可用序列化器的基类，常用的有：Serializer 序列化器基类，drf中所有的序列化器类都必须继承于 Serializer。
Rest_Framework简介
weixin_33755847的博客
05-12 201
Web应用模式 在开发Web应用中，有两种应用模式：前后端不分离和前后端分离 前后端不分离 前后端不分离通俗来讲就是不区分前端和后端，浏览器请求时服务器直接返回页面，其示意图如下 前后端分离 前后端分离是Web不断发展的结果，它将开发工作分为两块，前端和后端，前端负责静态页面的构建和数据展示，而数据则来自于后端，后端的工作在于对外提供统一的API接口，供前端调用获取数据，其示意图如下 AP...
Django+Vue.js快速搭建Web项目教程
使用Django REST framework，我们需要在app目录下创建一个serializers.py文件，定义模型序列化器，如下所示： 然后在views.py文件中创建视图，暴露API接口： 接着，在urls.py中配置URL路由，将视图与URL关联： 7、...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值