restful规范,序列化,drf

1 restufl规范(重要)

# 概念
REST全称是Representational State Transfer, 中文意思是表述:表征性状态转移,它首次出现在2000年Roy Fielding的博士论文中。

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

# 10个规范
	-1 数据的安全保障,通常使用https(http+ssl/tsl)协议
    	-url链接一般都采用https协议进行传输
        -采用https协议,可以提高数据交互过程中的安全性
        
    -2 接口中带api标识
    	-https://api.lqz.com/books
        -https://www.lqz.com/api/books    咱们用这个
    
    -3 多版本共存,路径中带版本信息
    	-https://api.lqz.com/v1/login
        -https://www.lqz.com/api/v2/login
    
    -4 数据即是资源,均使用名词,尽量不要出现动词(最核心的)
       -接口一般都是完成前后端数据的交互,交互的数据我们称之为资源
       -接口形式如下
    		https://api.baidu.com/users
             https://api.baidu.com/books
       -特殊的接口可以出现动词,因为这些接口一般没有一个明确的资源,或是动词就是接口的核心含义
    	-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  - delete请求:删除主键为1的书  
   -6 在请求地址中带过滤条件
		https://api.baidu.com/books?name=红&price=99
   -7 响应中状态码:两套
		-http响应状态码:1xx:请求正在处理,2xx:成功响应,3xx:重定向,4xx:客户端错误,5xx:服务端错误
    
         - https://blog.csdn.net/li_chunlong/article/details/120787872
         -公司内部规定的响应状态码,放在响应体中
        	{code:0}   咱们后期一般使用100 101 102这种
   
   -8 返回数据中带错误信息
    	{
            code: 0
            msg: "ok/用户名错误"
        }
            
   -9 返回的结果应该符合以下规范--->好多公司不遵循这个
		GET 获取所有数据:返回资源对象的列表(数组)[{name:红楼梦,price:99},{name:红楼梦,price:99},{name:红楼梦,price:99}]
    	GET 单个对象:返回单个资源对象:{name:红楼梦,price:99}
        POST 新增对象:返回新生成的资源对象:{name:西游记,price:99}
        PUT 修改对象:返回完整的资源对象:{name:西游记, price: 100}
        DELETE 删除:返回一个空文档
        
  -10 响应数据中带链接              

2序列化反序列化

# api接口开发,最核心最常见的一个过程就是序列化,所谓序列化就是把【数据转换格式】,序列化可以分两个阶段:

# 序列化:把我们识别的数据转换成指定的格式提供给别人
	-字典,列表----》json格式存到文件中了
    -例如:我们在django中获取到的数据默认是模型对象,但模型对象数据无法直接提供给前端或别的平台使用,所以我们需要把数据进行序列化,变成字符串或者json数据,提供给别人
    -read
    
# 反序列化:把别人提供的数据转换/还原成我们需要的格式    
	-例如:前端js提供过来的json数据,对于python而言就是字符串,我们需要进行反序列化转换成模型类对象,这样我们才能把数据保存到数据库中。
    -write

3基于django原生编写5个接口

# 以后写的接口,基本上都是5个接口及其变形
	-查询所有
    -查询单个
    -新增一个
    -修改一个
    -删除一个
    
# 基于books单表为例,写5个接口
	-创建book表
    -表迁移
    -录入假数据:直接录,后台管理录
    -写查询所有接口---》遵循restful规范,使用cbv
    -新增一个数据---》
    -查询一个
    -修改一个:put提交的数据,不能从requests.POST中取
    -删除一个


4 drf介绍和快速使用

# djangorestframework: drf 帮助我们快速的实现符合restful规范的接口

# django 最新 4.x,一般都会用最新版的上一般3.x
# drf最新支持django 3.x,最新不支持2.x
# 安装drf
	pip3 install djangorestframework -i http://pypi.douban.com/simple/ --trusted-host pypi.douban.com/simple/
    # 由于你是django2.x 它发现它不支持,它会自动写在dajgno,安装最新的django 4.x
    
    
    
# 使用drf编写5个接口(听个响)

# views中
from .serializer import BookSerializer
from rest_framework.viewsets import ModelViewSet
class BookView(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

# serializer
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'
        
# urls中
from rest_framework.routers import SimpleRouter
router = SimpleRouter()
router.register('books', views.BookView, 'books')

urlpatterns = [
    path('admin/', admin.site.urls),
]
# 两个列表相加  [1,2,4] +  [6,7,8]=
urlpatterns += router.urls

5cbv源码分析

# 1 路由中写的:path('api/v1/books/',views.BookView.as_view()),第二个参数无论是fbv还是cbv放的都是函数内存地址
	-当请求来了,匹配成功会执行,views.BookView.as_view()(request)
    -views.BookView.as_view()执行结果是View的类方法as_view返回的结果是内层函数view,是个函数内层地址
    -本身请求来了,匹配成功,会执行view(request)
    def view(request, *args, **kwargs):
        return self.dispatch(request, *args, **kwargs):
        
    -self.dispatch	View类的方法  
    def dispatch(self, request, *args, **kwargs):
        # request.method请求方式转成小写,必须在列表中才能往下走
        if request.method.lower() in self.http_method_names:
            # 反射,去self【视图类的对象:BookView】,去通过get字符串,反射出属性或方法
            # BookView的get方法
            handler = getattr(self, request.method.lower(),self.http_method_not_allowed)
       else:
            handler = self.http_method_not_allowed
        # BookView的get方法,加括号,传入request
        return handler(request, *args, **kwargs)
posted @ 2023-01-31 16:00  理塘丁真1!5!  阅读(17)  评论(0编辑  收藏  举报