DRF 工程搭建
1.DRF 介绍
- 在序列化与反序列化时,虽然操作的数据不尽相同,但是执行的过程却是相似的,也就是说这部分代码是可以复用简化编写的。
- 在开发REST API的视图中,虽然每个视图具体操作的数据不同,但增、删、改、查的实现流程基本套路化,所以这部分代码也是可以复用简化编写的:
- 增:校验请求数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
- 删:判断要删除的数据是否存在 -> 执行数据库删除
- 改:判断要修改的数据是否存在 -> 校验请求的数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
- 查:查询数据库 -> 将数据序列化并返回
3.DRF将序列化和反序列化的业务逻辑进⾏了封装,程序员只需要将序列化和反序列化的数据传给DRF即可
Django REST framework可以帮助我们简化上述两部分的代码编写,大大提高REST API的开发速度。
认识Django REST framework
Django REST framework 框架是一个用于构建Web API 的强大而又灵活的工具。
通常简称为DRF框架 或 REST framework。
DRF框架是建立在Django框架基础之上,由Tom Christie大牛二次开发的开源项目。
特点
提供了定义序列化器Serializer的方法,可以快速根据 Django ORM 或者其它库自动序列化/反序列化;
提供了丰富的类视图、Mixin扩展类,简化视图的编写;
丰富的定制层级:函数视图、类视图、视图集合到自动生成 API,满足各种需要;
多种身份认证和权限认证方式的支持;
内置了限流系统;
直观的 API web 界面;
可扩展性,插件丰富
资料:
-
2.环境安装与配置
DRF需要以下依赖:
- Python (3.5, 3.6, 3.7, 3.8, 3.9)
- Django (2.2, 3.0, 3.1)
DRF是以Django扩展应用的方式提供的,所以我们可以直接利用已有的Django环境而无需从新创建。(若没有Django环境,需要先创建环境安装Django)
1. 安装DRF
pip install djangorestframework
2. 添加rest_framework应用
我们利用在Django框架学习中创建的demo工程,在settings.py的INSTALLED_APPS中添加'rest_framework'。
INSTALLED_APPS = [
...
'rest_framework',
]
接下来就可以使用DRF进行开发了。
3.见识DRF的魅力
我们仍以在学习Django框架时使用的图书英雄为案例,使用Django REST framework快速实现图书的REST API。
3.1 创建序列化器
在dongman_pic应用中新建serializers.py用于保存该应用的序列化器。
创建一个Serializer.py文件,再创建一个PicInfoSerializer用于序列化与反序列化。
from rest_framework import serializers
from dongman_pic.models import PicInfo
class PicInfoSerializer(serializers.ModelSerializer):
"""图片数据序列化器"""
class Meta:
model = PicInfo
fields = '__all__'
- model 指明该序列化器处理的数据字段从模型类BookInfo参考生成
- fields 指明该序列化器包含模型类中的哪些字段,'all'指明包含所有字段
3.2 编写视图
在dongman_pic应用的views.py中创建视图PicInfoViewSet,这是一个视图集合。
from dongman_pic.models import PicInfo
from rest_framework.viewsets import ModelViewSet
from dongman_pic.serializer import PicInfoSerializer
class PicInfoView(ModelViewSet):
"""定义类视图"""
"""指定查询集"""
queryset = PicInfo.objects.all()
serializer_class = PicInfoSerializer
在使用DRF 前提是你已经将模型写好
3.3 定义路由
在book应用的urls.py中定义路由信息。
from book import views
from rest_framework.routers import DefaultRouter
urlpatterns = [
#path('picinfo/', views.PicListView.as_view()),
#path('picinfo/<int:pk>/', views.PicDetailView.as_view()),
]
router = DefaultRouter() # 可以处理视图的路由器
router.register('pics', views.PicInfoView) # 向路由器中注册视图集
urlpatterns += router.urls # 将路由器中的所以路由信息追到到django的路由列表中
注意:要将前面写的对应路由注释,否则以之前写的为准
3.4. 运行测试
运行当前程序(与运行Django一样)
python manage.py runserver
在浏览器中输入网址127.0.0.1:8000,可以看到DRF提供的API Web浏览页面:
1)点击链接127.0.0.1:8000/pics/ 可以访问获取所有数据的接口,呈现如下页面: