标签：02 name get api price request book DRF

DRF

restful规范(*)

概念

REST的全称是representational State Transfer，（表征性状态转移），它首次出现是在2000年 Roy Fielding 的博士伦文中。
RESTful是一种定义web API接口的设计风格，尤其适合于前后端分离的应用模式中

restful的十个规范

1.数据的安全保障，通常使用https（http+ssl/tsl）协议

- url 链接的一般都采用https协议进行传输
- 传输https协议，可以提高数据交互过程中的安全性

2.接口中带着API标识

例：
	-https://api.lqz.com/books
    -https://www.lqz.com/api/books  一般使用的这个

3.多版本共存，路径中带版本信息

当我们的程序迭代过后，有的用户不会更新程序，新的接口在旧的程序中就使用不了，就会保留着以前的接口
可以将版本号放在HTTP头信息中，也可以放入URL中

例：	
    -https://api.lqz.com/v1/login
    -https://www.lqz.com/api/v2/login

4.数据既是资源，均使用名词，尽量不要使用动词（这是最核心的）

接口一般都是完成前后端数据的交互，交互的数据我们称之为资源
路径是一种地址，在互联网上表现为网址，在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数，如https://api.专属域名.com/v1/students。

接口形式如下：

 例：   
     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
问号后面携带的就是过虑条件
1. ?limit=20：指定返回记录的数量为20；

2. ?offset=8：指定返回记录的开始位置为8；

3. ?page=1&per_page=50：指定第1页，以及每页的记录数为50；

4. ?sortby=name&order=asc：指定返回结果按照name属性进行升序排序；

5. ?animal_type_id=2：指定筛选条件。

7.响应中的状态码（两套）

- http响应状态码：
1xx ：请求正在处理
2xx ：成功响应
3xx ：重定向
4xx ：客户端错误
5xx ：服务端错误

-公司自己内部的状态码，放在响应体中
	back_dic={code:0} 后期会使用到 100 101 102 这类

8.返回数据中带有错误信息

PS：回顾之前的bbs项目中返回的数据中就有

back_dict={
    code:10000,
    msg:'用户名或密码错误'
}

9.返回的结果应该符合以下规范

PS：很多的公司不会遵循这个

GET :获取所有的数据 - 返回的资源对象的列表（数组）
	queryset：[{name:三国},{name:水浒},{name:聊斋}]
#通过get取的值是根据接口后面是否存在参数
GET :获取单个对象-返回单个资源对象
	queryset：[{name:三国，price：99}]
POST :新增对象 - 返回的是新生成的资源对象
	queryset:[{name:"西游记"，price：88}]
PUT ：修改对象 -返回完整的资源对象
	queryset：[{name:'三国'，price：99}]
DELETE : 删除对象 - 会返回一个空的文档
 ps: 在接口口后面可以带着参数指定删除某一个数据对象

10. 响应数据中携带者连接

序列化和反序列化

API接口开发，最核心最常见的就是序列化，所谓的序列化就是把 数据转换格式，序列化可以分为两个阶段
- 序列化：把我们能识别的数据转换成计算机能够识别的数据

字典，列表 ---->json格式存到文件中
例如：
	我们在django中获取到的数据默认是模型对象，但是模型对象是无法直接提供给前端或者别的平台使用，所以我们需要把数据进行序列化，变成字符串或者是json格式的数据，提供给别人。
    ---这种行为就是 read

反序列化：把别人提供的数据转换成我们需要的格式。

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

基于django原生编写5个接口

url路由代码

urlpatterns = [
    path('admin/', admin.site.urls),
    # path('api/v1/books',views.BookView.as_view()),
    # path('api/v1/books/<int:pk>',views.BookDataView.as_view()),
    re_path('api/v1/books/(?P<pk>\d+)',views.BookDataView.as_view())
]

models代码

class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)
    publish = models.CharField(max_length=32)

获取添加数据代码

class BookDataView(View):
    def get(self,request,pk):
        book=Book.objects.filter(pk=pk).first()
        # book模型对象转换成JsonResponse
        return JsonResponse({'id':book.id,'name': book.name, 'price': book.price, 'publish': book.publish})

    def put(self,request,pk):
        """
        request.POST只能获取到from-data的数据，put提交的数据获取不到 在这里修改数据需要json格式
        """
        book = Book.objects.filter(pk=pk).first()
        # 取出前端要修改的数据，
        # book.name=request.POST.get('name')
        # book.price=request.POST.get('price')
        # book.publish=request.POST.get('publish')
        # book.save()

        book_dic=json.loads(request.body)
        book.name=book_dic.get('name')
        book.price=book_dic.get('price')
        book.publish=book_dic.get('publish')
        book.save()

        return JsonResponse({'id':book.id,'name': book.name, 'price': book.price, 'publish': book.publish})

修改删除数据代码

class BookDataView(View):
    def get(self,request,pk):
        book=Book.objects.filter(pk=pk).first()
        # book模型对象转换成JsonResponse
        return JsonResponse({'id':book.id,'name': book.name, 'price': book.price, 'publish': book.publish})

    def put(self,request,pk):
        """
        request.POST只能获取到from-data的数据，put提交的数据获取不到 在这里修改数据需要json格式
        """
        book = Book.objects.filter(pk=pk).first()
        # 取出前端要修改的数据，
        # book.name=request.POST.get('name')
        # book.price=request.POST.get('price')
        # book.publish=request.POST.get('publish')
        # book.save()

        book_dic=json.loads(request.body)
        book.name=book_dic.get('name')
        book.price=book_dic.get('price')
        book.publish=book_dic.get('publish')
        book.save()

        return JsonResponse({'id':book.id,'name': book.name, 'price': book.price, 'publish': book.publish})


    # 删除功能
    def delete(self,request,pk):
        Book.objects.filter(pk=pk).delete()
        return JsonResponse(data={})

DRF介绍与快速使用

djangorestframework ——>简称drf 是为了帮助我们快速的实现符合restful规范的接口
现在的django最新的版本是4.x 我们在使用drf一般使用的是上一版本3.x
但是在下载drf的时候支持django3.x，最新的版本不支持2.x版本

安装drf

pip3 install djangorestframework -i http://pypi.douban.com/simple/ --trusted-host pypi.douban.com/simple/

 -- 由于我们使用django是2.x版本，它会发现不支持。就会自动卸载Django，安装最新的django4.x
 但是以为之前写代码的时候用的是django2.x版本，我们只需要将django的版本重新下会2.x的版本就能够使用drf了

使用drf编写5个接口（暂时了解）

views

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

在app01目录下创建一个新的文件

serializer代码

from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'

url代码

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

CBV源码分析

路由中写的：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)

标签：02,name,get,api,price,request,book,DRF
From： https://www.cnblogs.com/qiguanfusu/p/17080220.html

DRF 02

DRF