Django Rest_Framework
简介
核心思想: 缩减编写api接口的代码
Django REST framework（DRF）是一个建立在Django基础之上的Web 应用开发框架，可以快速的开发REST API接口应用。在REST framework中，提供了序列化器Serialzier的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。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 界面； - 可扩展性，插件丰富
## 环境安装与配置 ### 安装依赖 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）
### 安装 前提是已经安装了django，建议安装在虚拟环境
# mkvirtualenv drfdemo -p python3 # 创建虚拟环境， -p指定解释器
# pip install django
pip install djangorestframework
pip install pymysql
## 创建Django项目
cd ~/Desktop
django-admin startproject drfdemo
使用pycharm打开项目，设置虚拟环境的解析器，并修改manage.py中的后缀参数。
## 使用DRF ### 注册rest_framework应用 在**settings.py**的**INSTALLED_APPS**中添加'rest_framework'。 ```python INSTALLED_APPS = [ ... 'rest_framework', ]
接下来就可以使用DRF提供的功能进行api接口开发了。在项目中如果使用rest_framework框架实现API接口，主要有以下三个步骤：
- 将请求的数据（如JSON格式）转换为模型类对象
- 操作数据库
- 将模型类对象转换为响应的数据（如JSON格式）
<br>
### 创建子应用
创建一个子应用student并注册
<br>
### 创建模型类
在student.models里面写入如下代码
```python
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" # 指定表名，不指定时会默认以app名_model名来命名
verbose_name = "学生"
verbose_name_plural = verbose_name
### 创建数据库 ```sql create database students charset=utf8; ```
配置数据库
主应用中__init__.py设置使用pymysql作为数据库驱动
import pymysql
pymysql.install_as_MySQLdb()
setting.py里更改DATABASES设置
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",
}
}
### 数据迁移
python manage.py makemigrations
python manage.py migrate
执行python manage.py makemigrations时报错
解决方案：
注释掉 backends/mysql/base.py中的35和36行代码。
继续迁移，又报错
解决方案
backends/mysql/operations.py146行里面新增一个行代码：
### 创建序列化器 在student目录下面新建一个serializers.py用于保存改应用的序列化器
在serializers.py里创建一个StudentModelSerializer用于序列化和反序列化
# 创建序列化器类，回头会在视图中被调用
class StudentModelSerializer(serializers.ModelSerializer):
class Meta:
model = Student # 指定要操作的Model
fields = "__all__" # 序列化所有字段，即返回的数据中包含所有student的字段
- model 指明该序列化器处理的数据字段从模型类BookInfo参考生成
- fields 指明该序列化器包含模型类中的哪些字段，'all'指明包含所有字段
### 编写视图
在studnet.views里面创建视图集，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 指明该视图在进行序列化或反序列化时使用的序列化器
### 定义路由
在students应用的urls.py中定义路由信息。
from . import views
from rest_framework.routers import DefaultRouter
# 路由列表
urlpatterns = []
router = DefaultRouter() # 可以处理视图的路由器
router.register('students', views.StudentViewSet) # 向路由器中注册视图集
urlpatterns += router.urls # 将路由器中的所以路由信息追到到django的路由列表中
最后把student子应用中的路由文件加载到总路由文件中.
在drfdemo.urls.py里面
from django.contrib import admin
from django.urls import path,include
urlpatterns = [
path('admin/', admin.site.urls),
path("stu/",include("students.urls")),
]
### 运行测试 ```python python manage.py runserver
在浏览器中输入网址127.0.0.1:8000，可以看到DRF提供的API Web浏览页面：
点击链接，就可以访问数据接口
可以对数据进行增删该查操作啦~