核心思想:缩减编写api接口的代码
Django_Rest_Framework是一个建立在Django基础上的Web应用开发框架,可以快速的开发REST API接口的应用。在REST Framework中,提供了序列化器Serializer的定义,可以帮助我们简化序列化和反序列化的过程,不仅如此,还提供了丰富的类视图、扩展类、视图集来简化视图的编写工作。REST Framework还提供了认证、权限、分流、过滤、分页、接口文档等功能支持。REST framework提供了一个API的Web可视化洁面来方便查看测试接口。
中文文档:https://q1mi.github.io/Django-REST-framework-documentation/#django-rest-framework
github: https://github.com/encode/django-rest-framework/tree/master
特点:
提供了定义序列化器Serializer方法,可以快速根据Django ORM或者其他库自动序列化/反序列化;
提供了丰富的类视图、Mixin扩展类。简化视图的编写;
丰富的定制层级:函数视图、类视图、视图集和到自动生成API,买组各种需求;
多种身份认证和权限认证方式的支持;[jwt]
内置了限流系统;
直观的API web界面;
可扩展性,插件丰富;
安装预配置
1.DRF 需要下载的依赖包:
Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
Django(1.10, 1.11, 2.0)
注意:DRF是以Django扩展应用的方式提供的,所以我们可以直接利用已有的Django换件而无需从新创建。(若没有Django环境,需要先创建安装Django)
2.安装(前提是安装了python3,virtualenv和virtualenvwrapper管理工具,如果知道那是什么,请移步https://www.jianshu.com/p/21a9d49970e2)
$ mkvirtualenv drfdemo -p python3
$ pip install django
$ pip install djangorestframework
$ pip install pymysql
接下来我们试一试DRF简单体验一下
一、创建Django项目
$ cd ~/Desktop
$ django-admin startproject drfdemo
二、添加REST_framework应用
在settings.py的INSTALLED_APPS中添加rest_framework
[图片上传失败...(image-9fae98-1558169869591)]
接下里就可以使用DRF提供的功能进行API接口开发了。在项目中如果使用Rest_Framework框架实现API接口,主要有以下三个步骤:
- 将强求的数据(如Json格式)转换为模型类对象
- 操作数据库
- 将模型类对象转换为相应的数据(如Json格式)
三、终极体验DRF极简模式
class Student(models.Model): # 模型字段
name = models.CharField(max_length=100,verbose_name="姓名")
sex = models.BooleanField(default=1,verbose_name="性别")
age = models.IntegerField(verbose_name="年龄")
class_num = models.CharField(max_length=5,verbose_name="班级编号")
description = models.TextField(max_length=1000,verbose_name="个性签名")
class Meta:
db_table="tb_student"
verbose_name = "学生"
verbose_name_plural = verbose_name
1.1 为了方便测试,所以我们可以先创建一个数据库。(mysql数据库为例)
1.2 把students子应用添加到INSTALL_APPS中
1.3 初始化数据库连接
安装pymysql
$ pip install pymysql
主引用中__init__.py
设置使用pymysql作为数据库驱动
import pymysql
pymysql.install_as_MySQLdb()
settings.py配置文件中设置mysql的账号密码
DATABASES = {
# 'default': {
# 'ENGINE': 'django.db.backends.sqlite3',
# 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
# },
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': "students",
"HOST": "127.0.0.1",
"PORT": 3306,
"USER": "root",
"PASSWORD":"123",
}
}
1.4 终端下,执行数据迁移。
$ python manage.py makemigrations
$ python manage.py migrate
此时你可能遇到如下错误,别慌:
解决方案: 注释掉backends/mysql/bash.py中的35和36行代码。
再一次进行数据迁移,然后,wath!!!,又报错,别慌别慌:
解决方案: backends/mysql/operations.py146行里面新增一个行代码,如图:
这样再迁移一次,完美解决!!!其实报这个错误的原因是因为第三方包资源的问题,是因为我们django版本比较新,而mysql的一些包需要升级了,我们也可以把我们的django版本降低。但是我这样解决也问题不大。视需求而定吧。
2.创建序列化器
$ python manage.py startapp students
在students应用目录中新建serializers.py用于保存该应用的序列化器。
创建一个StudentModelSerializer用于序列化与反序列化。
from rest_framework import serializers
from .models import Students
# 创建序列化器类, 以供视图中使用
class StudentModelSerializer(serializers.ModelSerializer):
class Meta:
model = Student
fields = "__all__"
- model指明该序列化器处理的字段从模型类Student中生成
- fields指明该序列化器包含模型类中的那些字段,"all"指明包含所有字段
3.编写视图
在students应用的views.py中创建视图StudentViewSet,这是一个视图集合。
from rest_framework.viewsets import ModelViewSet
from .models import Student
from .serializers import StudentModelSerializer
# Create your views here
class StudentViewSet(ModelViewSet):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
- queryset指明该视图集在查询数据时使用的查询集
- serializer_class指明该视图在记性序列化或者反序列化时使用的序列化器
4.定义路由
在students应用的urls.py中定义路由信息
from . import views
from rest_framework.routers import DefaultRouter
urlpatterns = [] # 路由列表
router = DefaultRouter() # 可以处理视图的路由器
router.register('students', views.StudentViewSet) # 向路由器中注册视图集
urlpatterns += router.urls # 将路由器中的所有路由信息追加到Django的路由列表中
最后把students子应用中的路由文件加载到总路由文件中
from django.contrib import admin
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
path('stu/', include('students.urls')),
]
最后,运行一下,看看效果吧
(注意在项目根部录下运行,也及时manage.py文件所在路径)
$ python manage.py runserver
在浏览器中输入网址127.0.0.1:8000,可以看到DRF提供的API Web浏览页面:
1)点击链接127.0.0.1:8000/stu/students 可以访问 获取所有数据的接口,呈现如下页面:
2)在页面底下表单部分填写学生信息,可以访问 添加新学生的接口,保存学生信息:
点击POST后,返回如下页面信息:
3)在浏览器中输入网址127.0.0.1:8000/stu/students/5/,可以访问 获取单一学生信息的接口(id为5的学生),呈现如下页面:
4)在页面底部表单中填写学生信息,可以访问 修改学生的接口:
点击PUT,返回如下页面信息:
5)点击DELETE按钮,可以访问 删除学生的接口:
返回,如下页面: