Django的web框架Django Rest_Framework精讲(一)

本文涉及的产品
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
RDS MySQL Serverless 高可用系列,价值2615元额度,1个月
简介: Django的web框架Django Rest_Framework精讲(一)

Django Rest_Framework

1. DRF介绍

Django REST framework是一个建立在Django基础之上的Web 应用开发框架,可以快速的开发REST API接口应用,简称DRF。


在REST framework中,提供了序列化器Serialzier的定义,可以帮助我们简化序列化与反序列化的过程,把queryset类型数据自动转化为json等可以传到前端的数据类型

不仅如此,还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。


REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。

REST framework提供了一个API 的Web可视化界面来方便查看测试接口。


提供了我们写接口便利的方法,把响应的内容,响应的格式,响应状态码都封装好了

不用自己再做这些了,但是能DRF能做的还是有限的,对于复杂的接口还是需要自己来做这些事


restful不是必须的,但是为了后续开发,交接规范,大家约定俗成的使用restful规范

2.DRF特点

提供了定义序列化器Serializer的方法,可以快速根据 Django ORM 或者其它库自动序列化/反序列化;

提供了丰富的类视图、Mixin扩展类,简化视图的编写;

丰富的定制层级:函数视图、类视图、视图集合到自动生成 API,满足各种需要;

多种身份认证和权限认证方式的支持;[jwt]

内置了限流系统;

直观的 API web 界面;

可扩展性,插件丰富


django restframework(简称drf)本质上其实就是一个别人编写好的app,里面集成了很多编写restful API的功能功能。


其目录中有很多我们以前写django程序见到过的,因为它就是一个别人写好了的app,我们拿来用。


因此 每次新建项目时要记得在settings中注册app。


同时在settings中也要加上如下字典,以后drf相关的全局配置都会在该字典中添加。

3.环境安装与配置

(1)DRF需要以下依赖

  • Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6, 3.11)
  • Django (1.10, 1.11, 2.0, 4.2.1)

DRF是以Django扩展应用的方式提供的,所以我们可以直接利用已有的Django环境而无需从新创建。(若没有Django环境,需要先创建环境安装Django)


安装DRF,这是linux安装

前提是已经安装了django,建议安装在虚拟环境

#mkvirtualenv drfdemo -p python3
#pip install django

pip install djangorestframework

Windows就在本地环境中安装

(2)创建django项目


添加rest_framework应用,pycharm创建的项目,默认会把第一个创建的应用添加进去


在settings.py的INSTALLED_APPS中添加’rest_framework’。

需要手动将rest_framework 添加到INSTALLED_APPS 中,这个一定要手动添加,不然用不了drf功能

接下来就可以使用DRF提供的功能进行api接口开发了。在项目中如果使用rest_framework框架实现API接口,主要有以下三个步骤:


  • 将请求的数据(如JSON格式)转换为模型类对象
  • 操作数据库
  • 将模型类对象转换为响应的数据(如JSON格式)


创建模型操作类

class Student(models.Model):
    # 模型字段
    name = models.CharField(max_length=100,verbose_name="姓名",help_text='提示文本:不能为空')
    sex = models.BooleanField(default=1,verbose_name="性别")
    age = models.IntegerField(verbose_name="年龄")
    class_null = models.CharField(max_length=5,verbose_name="班级编号")
    description = models.TextField(max_length=1000,verbose_name="个性签名")

    #通过django migrate默认创建的表名是 应用名_类名小写,如果不想用默认的,可以自己配置表的元信息
    #通过class Meta类来配置
    class Meta:
        #配置表名
        db_table="tb_student"
        #这里是为了配置Django的后台管理系统admin里面的表名
        verbose_name = "学生"
        #这里是为了配置让表名不以复数形式显示,默认是以复数形式显示
        verbose_name_plural = verbose_name


我们看urls.py有个admin路径

当我们运行项目时,Django默认带个后台管理系统,需要先执行数据库同步指令

运行项目,登录后台管理系统


需要用户名,密码,初次登录需要我们创建超级管理员用户

控制台 python manager.py createsuperuser

按照提示输入,邮箱可以不用输入


输入用户名,密码登录

这里面有两张系统自带的表,生产中一般不用admin,由于admin功能太过简单,不符合生产要求

如果想用一个不错的后台管理系统,可以用xadmin

admin和xadmin是用来对数据库中的表进行管理的,项目中可能会写很多表。admin和xadmin就可以展示所有的表,以及表中数据

比如我们希望通过admin来管理模型类中的表

创建完,需要我们将models类里面的表注册到admin里面管理


在我们创建的应用下有个admin.py,专门用于admin后台管理系统的

注册模型类

#首先导包
from app01 import models
admin.site.register(models.Student)

重新运行项目,登录管理系统平台,可以看到我们app01应用下自己创建的表

class Meta:下面的verbose_name 就是配置在这里显示的表名

verbose_name_plural 是配置表名复数显示

比如我们注释后再看

表名 显示为我们创建的模型类 类名的复数形式

只配置verbose_name

表名默认以复数形式显示

配置好后,我们进入表中查看

我们可以直接通过这个后台管理系统管理我们的表,做增删改查

点击ADD学生,可以直接添加学生

页面字段显示中文,就是我们创建模型类时,每个字段指定了verbose_name 才能显示的

admin后台管理系统显示字段名称直接是通过verbose_name配置的名称来显示的

还有提示信息help_text 这些主要是给后台管理系统用的


整个admin后台管理系统是基于 form 和model-form开发的。数据检验用的

布尔值,在后台管理系统显示就是个单选框

添加表记录

点保存


默认展示的是模型类对象,怎么展示出表的字段名称呢,在admin.py中配置

现在看表中数据展示

想要修改字段,点击前面的id进入编辑界面



admin就是用来管理数据库表的

也可以查找

也可以直接在展示页面编辑,不能把id放进去

可以做批量修改


创建管理员以后,访问admin站点,先修改站点的语言配置,设置成显示中文 修改settings.py

LANGUAGE_CODE = ‘zh-hans’

重启服务,这样页面就是中文展示


这个admin功能不够全面,后面生产中我们使用xadmin,提供的功能更多

现在我们连接mysql数据库来进行drf操作

create database students;


在项目的__init__.py文件中配置pymysql使用mysql数据库,并兼容高版本mysql


此时,要把原先创建在sqlite3里面的数据迁移到mysql,由于初始化数据库同步语句已经生成了,数据库表没有变化,不要再执行makemigrations

只需要执行migrate

可能的报错处理

数据库中查看表


创建序列化器

创建个子应用 student

startapp student

记得将新创建的应用添加到INSTALLED_APPS里面

配置路由分发,在新创建的应用下创建urls.py文件

项目下的urls.py 将各个应用的url导入

在student应用目录中新建serializers.py用于保存该应用的序列化器。


创建一个StudentModelSerializer类用于序列化与反序列化。

#创建序列化器类,回头会在视图中被调用

#要继承rest_framework中的一个类ModelSerializer

from rest_framework.serializers import ModelSerializer
from app01 import models
class StudentModelSerializer(ModelSerializer):
    #配置元信息
    class Meta:
        model = models.Student
        fields = "__all__"
model 指明该序列化器处理的数据字段从模型类Student参考生成
fields 指明该序列化器包含模型类中的哪些字段,'__all__'指明包含所有字段

可以使用fields来明确字段,__all__表示包含所以字段,具体那些字段->fields = ('title','price')

由于之前admin管理后台创建的超级用户存在了sqlite3,现在数据库换成了mysql,需要重新创建一个,存在了django内置的auth-user表中

登录上去,添加些数据


视图类函数

from django.shortcuts import render

# Create your views here.

from app01 import models

from django.http import JsonResponse
#引入我们创建的序列化器类
from student.serializers import StudentModelSerializer
def students(request):
    method = request.method
    if method == 'GET':
        studentdata = models.Student.objects.filter()
        #序列化多条数据,需要加上many=True,返回序列化对象
        serializer_obj = StudentModelSerializer(instance=studentdata,many=True)
        #返回列表类型数据
        print(serializer_obj.data,type(serializer_obj.data))
        #JsonResponse返回非字典类型数据,需要加上safe=False,返回中文,需要加上, json_dumps_params={'ensure_ascii': False}  不然浏览器查看是Unicode码
        return JsonResponse(serializer_obj.data,safe=False, json_dumps_params={'ensure_ascii': False})

查看数据类型,每个字典由一个元祖包裹

浏览器访问,达到效果,前端拿到数据之后,方便循环来展示

DRF可以用一个方法实现5个接口,增删改查,我们视图使用CBV模式

视图类

from app01 import models

from django.http import JsonResponse
#引入我们创建的序列化器类
from student.serializers import StudentModelSerializer

#导入DRF的ModelViewSet类
from rest_framework.viewsets import ModelViewSet

#定义的视图类要继承ModelViewSet类
class StudentView(ModelViewSet):
    #queryset 指明该视图集在查询数据时使用的查询集
    #serializer_class  指明该视图在进行序列化或反序列化时使用的序列化器
    queryset = models.Student.objects.all()
    serializer_class = StudentModelSerializer

路由也由drf来注册生成

from student import views

#Django2之后的path不支持正则,正则使用re_path

urlpatterns = [
    # path('students/', views.students),
]

#使用rest_frame创建路由,首先导包
from rest_framework.routers import DefaultRouter
url_obj = DefaultRouter()    # 可以处理视图的路由器,自动通过视图来生成增删改查的url路径
url_obj.register('students',views.StudentView)     #students是生成的url前缀,名称随便写, 向路由器中注册视图集
urlpatterns += url_obj.urls   # 将路由器中的所有路由信息追到到django的路由列表中

浏览器访问查看,这些路由都是drf的defaultrouter对象自动生成的

DefaultRouter生成的接口路径太死板,在公司中我们也基本不用它,都是自己手写的

我们查看下students返回的json,页面视图都是drf提供的

视图页面是由ModelViewSet这个视图类提供的

正常的APIView或者View 页面都是返回的json字符串



如果我们不想看页面,也可以只看json数据,在url添加?format=json

这些都是DRF提供的功能

不仅提供了查看数据,也可以直接添加数据,可以直接在页面添加数据

不仅可以以form表单形式提交,还可以以原生json格式提交



输入数据,点POST直接添加到数据库

也可以查询指定id的数据

在浏览器中输入网址127.0.0.1:8000/stu/students/3/,可以访问获取单一学生信息的接口(id为3的学生),呈现如下页面:



可以直接修改数据,然后点击put提交

点击put后,返回修改后的数据

点击delete,可以删除本条记录

删除成功返回状态码204




序列化器类中,可以使用fields来明确字段,__all__表示包含所以字段,具体那些字段->fields = (‘title’,‘price’)

也可以序列化指定字段数据

访问接口查看



Django的web框架Django Rest_Framework精讲(二)https://developer.aliyun.com/article/1496740

相关实践学习
如何在云端创建MySQL数据库
开始实验后,系统会自动创建一台自建MySQL的 源数据库 ECS 实例和一台 目标数据库 RDS。
全面了解阿里云能为你做什么
阿里云在全球各地部署高效节能的绿色数据中心,利用清洁计算为万物互联的新世界提供源源不断的能源动力,目前开服的区域包括中国(华北、华东、华南、香港)、新加坡、美国(美东、美西)、欧洲、中东、澳大利亚、日本。目前阿里云的产品涵盖弹性计算、数据库、存储与CDN、分析与搜索、云通信、网络、管理与监控、应用服务、互联网中间件、移动服务、视频服务等。通过本课程,来了解阿里云能够为你的业务带来哪些帮助     相关的阿里云产品:云服务器ECS 云服务器 ECS(Elastic Compute Service)是一种弹性可伸缩的计算服务,助您降低 IT 成本,提升运维效率,使您更专注于核心业务创新。产品详情: https://www.aliyun.com/product/ecs
相关文章
|
16天前
|
数据采集 中间件 Python
如何在Django框架中进行输入验证和过滤?
通过综合运用这些方法,可以在 Django 框架中有效地进行输入验证和过滤,提高应用的安全性和数据质量。同时,还可以根据具体的业务需求进一步扩展和定制验证逻辑。
101 64
|
25天前
|
开发者 数据库管理 Python
Django框架和Flask框架的区别
总体而言,Django 适合需要快速搭建大型应用的开发者,而 Flask 则更适合有特定需求和追求灵活性的开发者。
109 64
|
1月前
|
设计模式 前端开发 数据库
Python Web开发:Django框架下的全栈开发实战
【10月更文挑战第27天】本文介绍了Django框架在Python Web开发中的应用,涵盖了Django与Flask等框架的比较、项目结构、模型、视图、模板和URL配置等内容,并展示了实际代码示例,帮助读者快速掌握Django全栈开发的核心技术。
162 45
|
16天前
|
监控 安全 测试技术
Django框架的表单验证和过滤机制是否可以应对复杂的安全场景?
综上所述,Django 框架的表单验证和过滤机制在一定程度上可以应对复杂的安全场景,但需要综合运用多种手段来进一步提升安全性,以适应不断变化的安全挑战。
26 1
|
23天前
|
搜索推荐 API 开发者
Django框架和Flask框架的适用场景分别是什么?
总体而言,Django 更适合需要全面功能和大规模开发的场景,而 Flask 则更适合灵活性要求高、小型项目或特定需求的开发。当然,具体的选择还应根据项目的具体情况、团队的技术能力和偏好等因素来综合考虑。在实际应用中,开发者可以根据项目的特点和需求,灵活选择使用这两个框架,或者结合它们的优势来构建更强大的 Web 应用程序。
|
23天前
|
开发框架 搜索推荐 数据可视化
Django框架适合开发哪种类型的Web应用程序?
Django 框架凭借其强大的功能、稳定性和可扩展性,几乎可以适应各种类型的 Web 应用程序开发需求。无论是简单的网站还是复杂的企业级系统,Django 都能提供可靠的支持,帮助开发者快速构建高质量的应用。同时,其活跃的社区和丰富的资源也为开发者在项目实施过程中提供了有力的保障。
|
23天前
|
开发框架 JavaScript 前端开发
TypeScript 是一种静态类型的编程语言,它扩展了 JavaScript,为 Web 开发带来了强大的类型系统、组件化开发支持、与主流框架的无缝集成、大型项目管理能力和提升开发体验等多方面优势
TypeScript 是一种静态类型的编程语言,它扩展了 JavaScript,为 Web 开发带来了强大的类型系统、组件化开发支持、与主流框架的无缝集成、大型项目管理能力和提升开发体验等多方面优势。通过明确的类型定义,TypeScript 能够在编码阶段发现潜在错误,提高代码质量;支持组件的清晰定义与复用,增强代码的可维护性;与 React、Vue 等框架结合,提供更佳的开发体验;适用于大型项目,优化代码结构和性能。随着 Web 技术的发展,TypeScript 的应用前景广阔,将继续引领 Web 开发的新趋势。
35 2
|
25天前
|
安全 前端开发 数据库
Django框架
总的来说,Django 是一个非常优秀的 Web 框架,它为开发者提供了坚实的基础和丰富的功能,使得构建高质量的 Web 应用变得更加容易和高效。无论是初学者还是经验丰富的开发者,都可以从中受益,利用它来实现自己的创意和想法。
38 4
|
29天前
|
Python
Django 框架的路由系统
Django 框架的路由系统
40 6
|
24天前
|
中间件 Go API
Go语言中几种流行的Web框架,如Beego、Gin和Echo,分析了它们的特点、性能及适用场景,并讨论了如何根据项目需求、性能要求、团队经验和社区支持等因素选择最合适的框架
本文概述了Go语言中几种流行的Web框架,如Beego、Gin和Echo,分析了它们的特点、性能及适用场景,并讨论了如何根据项目需求、性能要求、团队经验和社区支持等因素选择最合适的框架。
63 1