drf-Restful规范

drf介绍

全名 rest_framework 简称drf 是一个依赖与django的一个APP应用

restful是什么？

REST全称是Representational State Transfer，表征性状态转移
Web API接口的设计风格，尤其适用于前后端分离的应用模式中、

有哪些规范 10 条？

1 数据的安全保障：url链接一般都采用https协议进行传输
-https是：http+ssl 安全的超文本传输协议

2 接口特征表现：在API地址中带接口标识，咱们一般放在地址栏中(放在域名中)
https://api.baidu.com
https://www.baidu.com/api

3 多版本共存：在url链接中带版本标识
-https://api.weibo.com/2/
-https://api.weibo.com/v2/
-https://api.weibo.com/?version=2
-https://api.weibo.com/v1/login —>需要的参数name和pwd
-https://api.weibo.com/v2/login —>需要的参数name和pwd和code

4 数据即是资源，均使用名词（可复数）：前后端交互的数据我们称之为资源
-资源名都是名词,尽量避免使用动词
-https://127.0.0.1/api/v1/users
-https://127.0.0.1/api/v1/get_users # 不符合规范

5 资源操作由请求方式决定（method）
-获取资源用get
-新增资源用post
-修改资源使用put
-删除资源使用delete
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?name=猴子 get请求

7 响应状态码：响应中带状态码
-http响应状态码：1xx，2xx，3xx，4xx，5xx
-自己的状态码（用的多）： 100成功，看公司自己
错误代码 错误信息 详细描述
10001 System error 系统错误
10002 Service unavailable 服务暂停
10003 Remote service error 远程服务错误
10004 IP limit IP限制不能请求该资源
10005 Permission denied, need a high level appkey 该资源需要appkey拥有授权

8 返回中带错误信息
{code:100,msg:成功}
“Message”: “send success”,

9 返回结果，符合以下规范
GET /collection：返回资源对象的列表（数组） [{name:xx,age:19},{name:xx,age:19},{}]
GET /collection/resource：返回单个资源对象 {name:xx,age:19}
POST /collection：返回新生成的资源对象 {name:yy,age:19}
PUT /collection/resource：返回完整的资源对象 {name:xx,age:20}
PATCH /collection/resource：返回完整的资源对象 {name:xx,age:20}
DELETE /collection/resource：返回一个空文档

10 返回数据中带url链接
“url”: “http://blog.sina.com.cn/zaku”,

序列化和反序列化

序列化： 把我们能识别的数据结构(python的字典，列表，对象)—》转>换成其他语言(程序)能识别的数据结构
-python的字典，列表，对象-----》json格式字符串（可以是别的格式）
-前后端交互，目前通常使用 json格式字符串交互
-前后端分离模式中：主要指的是
-前端发送请求获取数据—》后端去数据库查询—》QuerySet对象—》转成json格式字符串—》返回给前端这个过程，称之为序列化

反序列化：把其他程序(语言)给我们的数据—》转换成我们能识别的数据结构
-前端给我们json格式数据 —》转换成 字典，列表，对象
-前端给 name=lqz&age=19 格式数据 —》转换成 字典，列表，对象
-前后端分离模式中：主要指的是
-前端携带json格式数据到后端----》后端拿到json格式数据—》把数据转成对象保存到数据库这个过程，咱们称之为反序列化

        # Object of type QuerySet is not JSON serializable  Queryset对象不允许用json序列化
        # json能序列化什么数据类型？
        '''
         +---------------+-------------------+
        | JSON          | Python            |
        +===============+===================+
        | object        | dict              |
        +---------------+-------------------+
        | array         | list              |
        +---------------+-------------------+
        | string        | str               |
        +---------------+-------------------+
        | number (int)  | int               |
        +---------------+-------------------+
        | number (real) | float             |
        +---------------+-------------------+
        | true          | True              |
        +---------------+-------------------+
        | false         | False             |
        +---------------+-------------------+
        | null          | None              |
        +---------------+-------------------+
        '''

Django REST framework安装和快速使用

pip3 install django djangorestframework 3.14.0
注意 ：
django 版本过低或者 djangorestframework 过高 可能会发生兼容性问题

局部禁用CSRF认证 只能是FBV方式

from django.views.decorators.csrf import csrf_exempt
@csrf_exempt  #本质 index= csrf_exempt(index)
def index(request):
    return render(request,'index.html')

原生django和drf的区别

使用原生django实现5个接口

# 视图层
# 作业 使用 Viwe写五个接口
# 查询所有和 添加
class Book_view(View):
	# Queryset对象不允许用json序列化 只能序列化相应的数据类型
    def get(self,request):
        books = models.Book_list.objects.all()
        d = []
        for book in books: # 字典类型可以序列化 转成字段在序列化出去
           d.append({'name':book.title,'price':book.price,'publish':book.publish,'addr':book.addr})

        return JsonResponse({'code':100,',msg':'查询所有成功','result':d})

    def post(self,request):

        data = json.loads(request.body)

        book = models.Book_list.objects.create(**data)

        return JsonResponse({'code':101,'msg':'添加数据成功','result':{'title':book.title,'price':book.price,'publish':book.publish,'addr':book.addr}})

# models模型层
class Book_list(models.Model):
    id = models.AutoField(primary_key=True)
    title = models.CharField(max_length=32)
    price = models.DecimalField(max_digits=7,decimal_places=2)
    publish = models.CharField(max_length=32)
    addr = models.CharField(max_length=32)

# 路由层
from django.urls import path
from app01 import views
from app01.views import *

urlpatterns = [
    path('Book_view/', Book_view.as_view()),
    path('Book_vies_id/<int:pk>', Book_vies_id.as_view()),
]

使用drf实现5个接口

# 视图层
from .models import Book
from .serializer import BookSerializer
from rest_framework.viewsets import ModelViewSet

class BookView(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

# 模型层 和序列化类
class Book_list(models.Model):
    id = models.AutoField(primary_key=True)
    title = models.CharField(max_length=32)
    price = models.DecimalField(max_digits=7,decimal_places=2)
    publish = models.CharField(max_length=32)
    addr = models.CharField(max_length=32)

from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book_list # 序列化关联的表
        fields = '__all__'

# 路由
from rest_framework.routers import SimpleRouter
router = SimpleRouter()
router.register('books', views.BookView, 'books')
urlpatterns = [
]
urlpatterns += router.urls

总结

1 继承APIView后，所有视图类，都没有csrf认证了，我们也不需要注释全局中间件了
1 csrf_exempt(view) —》
2 装饰器

1 APIView执行流程—》去除csrf–》执行了APIView的dispatch
2 执行的as_view是APIView的as_view
3 执行的dispatch也是APIView的dispatch