Python笔记_60_Django-DRF_Web应用模式_API接口_序列化_Django Rest_Framework_简单使用

Django-DRF

Django Rest_Framework

WEB应用模式

• 前后端不分离
  
• 前后端分离
  

API接口

API（Application Programming Interface，应用程序接口）

应用程序接口又称为应用编程接口，是一组定义、程序及协议的集合，通过 API接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。API同时也是一种中间件，为各种不同平台提供数据共享。
目前市面上大部分公司开发人员使用的接口服务架构主要有：restful、rpc。

• 远程过程调用（RPC）
  通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。
• 表述性状态转移（RESTful）
  REST（英文：Representational State Transfer，简称REST）描述了一个架构样式的网络系统，比如 web 应用程序。把后端所有的数据/文件都看成资源，那么接口请求数据,本质上来说就是对资源的操作了.

RESTful API规范

RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。

这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。而对于数据资源分别使用POST、DELETE、GET、UPDATE等请求动作来表达对数据的增删查改。

RESTful 架构详解

RESTful是一种开发理念 . REST是设计风格而不是标准
REST特点 : url简洁,将参数通过url传到服务器.

序列化

api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式。

序列化可以分两个阶段：

• 序列化
  把我们识别的数据转换成指定的格式提供给别人。
• 反序列化
  把别人提供的数据转换/还原成我们需要的格式。

Django Rest_Framework

核心思想: 缩减编写api接口的代码
Django REST framework是一个建立在Django基础之上的Web 应用开发框架，可以快速的开发REST API接口应用。

在REST framework中，提供了序列化器Serializer的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。

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

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

中文文档

特点:

提供了定义序列化器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）

• 安装DRF

pip install djangorestframework
pip install pymysql

• 创建一个Django项目

django-admin startproject drfdemo

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

INSTALLED_APPS = [
    ...
    'rest_framework',
]

实现ModelSerializer过程

• 创建模型类（此时项目还没有app，自行创建）

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_null = 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

• 创建序列化器
  在django项目中创建学生子应用。
  在syudents应用目录中新建serializers.py用于保存该应用的序列化器。
  　　创建一个StudentModelSerializer用于序列化与反序列化。

  from rest_framework import serializers
  from students.models import Student
   
   
  # 创建序列化器类，回头会在视图中被调用
  class StudentModelSerializer(serializers.ModelSerializer):
      class Meta:
          model = Student
          fields = "__all__"
          # fields = ("id", "name")  # 也可指定字段
  

  • model 指明该序列化器处理的数据字段从模型类Student参考生成
  • fields 指明该序列化器包含模型类中的哪些字段，__all__指明包含所有字段

• 编写视图
  在students应用的views.py中创建视图StudentViewSet，这是一个视图集合。

  from rest_framework.viewsets import ModelViewSet
  from students.models import Student
  from students.serializers import StudentModelSerializer
   
   
  class StudentAPIView(ModelViewSet):
      queryset = Student.objects.all()
      serializer_class = StudentModelSerializer
  

  • queryset 指明该视图集在查询数据时使用的查询集
  • serializer_class 指明该视图在进行序列化或反序列化时使用的序列化器

• 定义路由
  在students应用的urls.py中定义路由信息。

  from rest_framework.routers import DefaultRouter
  from students import views
   
  urlpatterns = []  # 路由列表
   
  router = DefaultRouter()  # 可以处理视图的路由器
   
  router.register('student', views.StudentAPIView)  # url进行注册
   
  urlpatterns += router.urls  # 将路由器中的所有路由信息追加到django的路由列表中
  

  最后把students子应用中的路由文件加载到总路由文件中.

  urlpatterns = [
      path('admin/', admin.site.urls),
      path('drf/', include("students.urls")),
  ]
  

• 运行测试
  在浏览器中输入网址: 127.0.0.1:8000/drf/，可以看到DRF提供的API Web浏览页面：在浏览器中输入网址: 127.0.0.1:8000/drf/student/可以访问获取所有数据的接口，呈现如下页面：
  在浏览器中输入网址127.0.0.1:8000/drf/student/2/，可以访问获取单一学生信息的接口（id为2的学生），呈现如下页面：
  在页面底部表单中填写学生信息，点击PUT可以访问修改学生的接口
  点击DELETE按钮，可以访问删除学生的接口: