DRF入门规范

Posted 2021-06-11 Palpitate

DRF简介

Django Rest_Framework

"""
核心思想: 缩减编写api接口的代码

Django REST framework是一个建立在Django基础之上的Web 应用开发框架，可以快速的开发REST API接口应用。
在REST framework中，提供了序列化器Serialzier的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。
REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework提供了一个API 的Web可视化界面来方便查看测试接口。
"""

 

DRF特点

"""
提供了定义序列化器Serializer的方法，可以快速根据 Django ORM 或者其它库自动序列化/反序列化；
提供了丰富的类视图、Mixin扩展类，简化视图的编写；
丰富的定制层级：函数视图、类视图、视图集合到自动生成 API，满足各种需要；
多种身份认证和权限认证方式的支持；[jwt]
内置了限流系统；
直观的 API web 界面；
可扩展性，插件丰富
"""

 

序列化

"""
把我们识别的数据转换成指定的格式提供给别人。

例如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给别人。
"""

 

反序列化

"""
把别人提供的数据转换/还原成我们需要的格式。

例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。
"""

 

web开发模式

# 前后端混合开发(前后端不分离):返回的是html的内容

# 什么是动态页面(查数据库的)，什么是静态页面(静止的html)
# 页面静态化

 

API接口

"""
通过网络，规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介

# 百度地图 肯德基api
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json



# 请求头中User-Agent:客户端的类型

# 请求头中加其他参数：
"""

 

postman的使用

# postman是目前最好用的，模拟发送http请求的工具
# 双击安装，安装完自动打开

# 解析json的网站
https://www.json.cn/

 

restful规范(十条)

REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征性状态转移）。 它首次出现在2000年Roy Fielding的博士论文中。

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

这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。

事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。

# 抓包工具：
    fiddler  charles

# 10条规范
1、 数据的安全保障：url链接一般都采用https协议进行传输   注：采用https协议，可以提高数据交互过程中的安全性

2、接口特性表现：一看就知道是个api接口
    用api关键字标识接口url：
    https://api.baidu.com
    https://www.baidu.com/api
    注：看到api字眼，就代表该请求url链接是完成前后台数据交互的
    
3、多数据版本共存
    在url链接中标识数据版本
    https://api.baidu.com/v1
    https://api.baidu.com/v2
    注：url链接中的v1、v2就是不同数据版本的体现（只有在一种数据资源有多版本情况下）
    
4、数据即是资源，均使用名词（可复数）
    接口一般都是完成前后台数据的交互，交互的数据我们称之为资源
    https://api.baidu.com/users
    https://api.baidu.com/books
    https://api.baidu.com/book
    注：一般提倡用资源的复数形式，在url链接中奖励不要出现操作资源的动词，错误示范：https://api.baidu.com/delete-user
    特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义
    https://api.baidu.com/place/search
    https://api.baidu.com/login
       
5、资源操作由请求方式决定（method）
    操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作
    https://api.baidu.com/books - get请求：获取所有书
    https://api.baidu.com/books/1 - get请求：获取主键为1的书
    https://api.baidu.com/books - post请求：新增一本书书
    https://api.baidu.com/books/1 - put请求：整体修改主键为1的书
    https://api.baidu.com/books/1 - patch请求：局部修改主键为1的书
    https://api.baidu.com/books/1 - delete请求：删除主键为1的书
        
6、 过滤，通过在url上传参的形式传递搜索条件
    https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
    https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
    https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
    https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
    https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件
        
7、响应状态码
    7.1 正常响应
        响应状态码2xx
        200：常规请求
        201：创建成功
    7.2 重定向响应
        响应状态码3xx
        301：永久重定向
        302：暂时重定向
    7.3 客户端异常
        响应状态码4xx
        403：请求无权限
        404：请求路径不存在
        405：请求方法不存在
    7.4 服务器异常
        响应状态码5xx
        500：服务器异常
        
8、 错误处理，应返回错误信息，error当做key
    {
        error: "无权限操作"
    }
    
9、 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范
    GET /collection：返回资源对象的列表（数组）
    GET /collection/resource：返回单个资源对象
    POST /collection：返回新生成的资源对象
    PUT /collection/resource：返回完整的资源对象
    PATCH /collection/resource：返回完整的资源对象
    DELETE /collection/resource：返回一个空文档
    
10、需要url请求的资源需要访问资源的请求链接(响应的数据里面可以带链接)
    # Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么
    {
        "status": 0,
        "msg": "ok",
        "results":[
            {
                "name":"肯德基(罗餐厅)",
                "img": "https://image.baidu.com/kfc/001.png"
            }
            ...
            ]
    }

 

drf的安装和简单使用

# 安装：pip install djangorestframwork==3.10.3
# 使用
    1、在settings的app中注册
        INSTALLED_APPS = [
            \'rest_framework\',
        ]
    2、在models.py中写表模型
    class Book(models.Model):
        nid = models.AutoField(primary_key=True)
        name = models.CharField(max_length=34)
        price = models.DecimalField(max_digits=5, decimal_places=2)
        author = models.CharField(max_length=32)
    3、新建一个序列化类
    from rest_framework.serializers import ModelSerializer
    from app01.models import Book

    class BookModelSerializer(ModelSerializer):
        class Meta:
            model = Book
            fields = \'__all__\'
    4、在视图中写视图类
        from rest_framework.viewsets import ModelViewSet
        from .models import Book
        from .ser import BookModelSerializer

        class BookViewSet(ModelViewSet):
            queryset = Book.objects.all()
            serializer_class = BookModelSerializer
    5、写路由关系
        from django.contrib import admin
        from django.urls import path
        from app01 import views
        from rest_framework.routers import DefaultRouter

        router = DefaultRouter()  # 可以处理视图的路由器
        router.register(\'book\', views.BooksViewSet)  # 向路由器中注册视图集

        # 将路由器中的所以路由信息追到到django的路由列表中


        urlpatterns = [
            path(\'admin/\', admin.site.urls),
        ]
        # 这是什么意思？  两个列表相加
        # router.urls列表
        urlpatterns += router.urls
    6、启动，在postman中测试即可
   

 

request对象性

from rest_framework.request import Request
# 以后只要继承了APLView，视图中的request对象，都是新的，也就是上面那个request的对象了
# 老的request在新的request._request
# 以后使用request对象，就像使用之前的request是一模一样的(重写了__getattr__方法)

def __getattr__(self, attr):
        try:
            # 通过反射，如果要取request.method,是去_request里面去取了
            return getattr(self._request, attr) 
        except AttributeError:
            return self.__getattribute__(attr)

        
        
# request.data  感觉是个数据属性，其实是个方法   @property修饰了
# 它是一个字典，post请求不管使用什么编码，传过来的数据，都在request.data
 @property
 def data(self):
        if not _hasattr(self, \'_full_data\'):
            self._load_data_and_files()
        return self._full_data
    

# get请求传过来的数据，从哪里取？ request.GET 和 request.query_params都可以
    @property
    def query_params(self):
        """
        More semantically correct name for request.GET.
        """
        return self._request.GET
    
    # views.py中 ： 
    print(request.query_params)  # get请求，地址中的参数
    # 原来在request.GET
    print(request.GET)

 

APIView的initial(三大认证模块)

def initial(self, request, *args, **kwargs):
    # 认证组件：校验用户 - 游客、合法用户、方法用户
    # 游客：代表校验通过，直接进入下一步校验(权限校验)
    # 合法用户：代表校验通过，将用户存储在request.user中，再进入下一步校验(权限校验)
    # 非法用户：代表校验失败，抛出异常，返回403权限异常结果
    self.perform_authentication(request) 
    # 权限组件：校验用户权限 - 必须登录、所有用户、登录读写游客只读、自定义用户角色
    # 认证通过：可以进入下一步校验(频率认证)
    # 认证失败：抛出异常，返回403权限异常结果
    self.check_permissions(request)
    # 频率组件：限制视图接口被访问的频率次数 - 限制的条件(IP、id、唯一键)、频率周期时间(s、m、d)、频率的次数(3/s)
    # 没有达到限次：正常访问接口
    # 达到限次：限制时间内不能访问，限制时间达到后，可以重新访问
    self.check_throttles(request)

 

补充：

一切皆对象

def foo(a,b):
    return a+b
foo.name = \'lqz\'  # 由于一切皆对象，函数也是个对象，对象放值

print(foo(2,3))
print(foo.name)

 

局部禁用

http://liuqingzheng.top/python/Django%E6%A1%86%E6%9E%B6/16-Django%E9%AB%98%E7%BA%A7%E4%B9%8B-%E4%B8%AD%E9%97%B4%E4%BB%B6/
    
# 在视图函数上加装饰器@csrf_exempt
# csrf_exempt(view)这么写和在视图函数上加装饰器是一毛一样的

# urls.py中看到这种写法：就相当于加了csrf装饰器
from django.views.decorators.csrf import csrf_exempt
path(\'test/\',csrf_exempt(views.test)),