DRF

web应用模式
API接口
接口测试工具postman
restful规范
序列化与反序列化
基于django编写5个接口
- 代码
drf安装
用def写5个接口
cbv源码分析

web应用模式

django web框架用来也web项目

前后端混合开发， 之前学的。BBS项目图书管理系统都属于。
其实写的是模板语法。 pycharm内的html文件内的代码。
"全栈开发-前后端混合"

前后端分离今后学习的

只需要把接口写好。
"全栈开发- web后端，前端框架 （vue）"

API接口

# 为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本【前后端】


# 通过网络，规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介
    http://127.0.0.1/books/   
	点赞，点踩  就是API接口
# api接口：就是前后端交互的媒介
	-url地址：https://api.map.baidu.com/place/v2/search
    -请求方式：get，post，delete，put。。。。
    -请求参数：json格式的key-value类型数据
    	-早些年 前后端交互使用xml格式----》ajax：异步JavaScript和XML
        -后来，随着json格式的出现，成了主流，直到现在
        -以后：一定会出现，比json更高效的交互格式，更安全
    -响应结果：json格式的数据
    
    
    
# api接口案例
-https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=上海&query=肯德基&output=xml
    
-https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=上海&query=肯德基&output=json

接口测试工具postman

# 作为后端，写好了接口，我们自己要测试通过，再给别人用

# 写的接口，需要有个工具测试    
	-浏览器只能发送get请求，不能自动发送post，delete请求
    -postman---》开源软件，只是谷歌浏览器的插件，越做好好，后来可以按装到操作系统上，再后来，收费
    -postwoman
    -很多很多其他的，不同公司用的也可能不一样，你只需要明白一个点，这个工具只是用来发送http请求
    
    
# postman的使用
	-1 官方下载：https://www.postman.com/downloads/?utm_source=postman-home----》Postman-win64-Setup.exe
    -2 按照，双击即可

restful规范

RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的项目

共有十个规范

1.数据的安全保障，通常使用https协议 # https就是(http_ssl/tsl)协议
	url链接一般都采用https协议进行传输
   采用https协议，可以提高数据交互过程中的安全性

2.接口中带API标识
   共有两种方式
   https://api.lqz.com/books
   https://www.lqz.com/api/books   # 咱们以后主要使用这种
  
3.多版本共存，路径中带版本信息
	因多版本需要新旧版本同样可以使用，所以需要多版本共存并在路径中带版本信息。
   eg:
     https://api.lqz.com/v1/login
     https://www.lqz.com/api/v2/login

4.数据即是资源，均使用名词，尽量不出现动词。*
	接口一般都是完成前后台数据的交互，交互的数据我们称之为资源
   eg：
     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=20
   
7. 响应状态码。
	一般有两套一套是http响应码一套是公司中规定的响应码
    http响应状态码：
    		1xx 请求正在处理
          2xx 成功响应
          3xx 重定向
          4xx 客户端错误
          5xx 服务端错误 
        https://blog.csdn.net/li_chunlong/article/details/120787872
    公司内部规定的响应状态码，放在响应体中
    {'code':10001}

8.返回数据中带错误信息
	{'code':10001,
    'msg':'密码错误'}

9.返回的数据格式应符合下列规范 
    GET 获取所有数据：返回资源对象的列表（数组）[{}，{}，{}]
    GET 单个对象：返回单个资源对象：{}
    POST 新增对象：返回新生成的资源对象：{}
    PUT 修改对象：返回完整的资源对象 ：{}
    DELETE 删除：返回一个空文档 
		"也有公司不遵循这个规范"
        
10. 响应中带链接

序列化与反序列化

api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式就是我们之前使用的json相关的模块，序列化可以分两个阶段

# 序列化： 把我们识别的数据转换成指定的格式(json格式)提供给别人
	-字典，列表------》json格式存到文件中了
    		
	-例如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给别人
    "# 模型对象：因为模型层点出来的对象，一般称为模型对象"
	-read
# 反序列化：把别人提供的数据转换/还原成我们需要的格式。

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

基于django编写5个接口

以后写的接口，基本上都是5个接口及其变形

1.查询所有
2.查询单个
3.新增一个
4.修改一个
5.删除一个

代码

from django.shortcuts import render
from django.views import View
# Create your views here.
from .models import Books
from django.http import JsonResponse
import json


class BookView(View):
    def get(self, request):
        # 获取所有书籍
        books = Books.objects.all()
        # 转成json格式 返回给前端
        book_list = []
        for book in books:
            book_list.append({'id': book.id, 'name': book.name, 'price': book.price, 'publish': book.publish})
        return JsonResponse(book_list, safe=False, json_dumps_params={'ensure_ascii': False})

    def post(self, request):
        # 新增一个书籍
        # 获取数据
        """
        request.POST内只能携带urlencoded或form-data编码  json形式编码不行，需要从request.body内获取
        测试得知不论前端是否使用json格式传数据body内都有值，所以不能判断body是否有值写逻辑
        """
        if not request.POST:
            print('没有值')
            book_dict = json.loads(request.body)
            name = book_dict.get('name')
            price = book_dict.get('price')
            publish = book_dict.get('publish')
            book = Books.objects.create(name=name, price=price, publish=publish)
        else:
            print('有值')
            name = request.POST.get('name')
            price = request.POST.get('price')
            publish = request.POST.get('publish')
            book = Books.objects.create(name=name, price=price, publish=publish)

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

class BookDetailView(View):
    # 查询一个数据
    def get(self,request,pk):
        book = Books.objects.filter(pk=pk).first()
        return JsonResponse({'pk':book.pk,'name':book.name,'price':book.price,'publish':book.publish})

    # 修改一个数据
    def put(self,request,pk):
        book = Books.objects.filter(pk=pk).first()
        "报错,因为put提交的数据不在request.POST中需要从body内获取数据，因此也不能使用form-data和urlencoded修改只能使用json格式"
        # book.name = request.POST.get('name')
        # book.price = request.POST.get('price')
        # book.publish = request.POST.get('publish')
        # book.save()
        "从body内拿数据"
        book_dict = json.loads(request.body)
        book.name = book_dict.get('name')
        book.price = book_dict.get('price')
        book.publish = book_dict.get('publish')
        book.save()
        return JsonResponse({'pk': book.pk, 'name': book.name, 'price': book.price, 'publish': book.publish})

    def delete(self,request,pk):
        Books.objects.filter(pk=pk).delete()
        return JsonResponse({})
    
models内
from django.db import models
class Books(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)
    publish = models.CharField(max_length=32)

urls内
from django.contrib import admin
from django.urls import path
from app01 import views
urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/v1/books/',views.BookView.as_view()),
    path('api/v1/books/<int:pk>',views.BookDetailView.as_view()),
]

drf安装

在安装drf时需要注意的事情，如果本身的django版本是3.0以下那么在安装drf时会自动卸载3.0以下版本，安装django最新版，但是我们之前用3.0以下的版本编写的代码可能出现不兼容所以

方式1：安装def自动卸载django旧版本安装django新版本后重新降回老版本

方式2：安装django3.0以上版本

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

用def写5个接口

# views中
from .serializer import BookSerializer
from rest_framework.viewsets import ModelViewSet

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

# serializer.py 文件
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),
]
urlpatterns += router.urls

cbv源码分析

1.我们在路由中填写的path('api/v1/books/', views.BookView.as_view()) 
其实在匹配成功时所执行的都是'views.BookView.as_view()(request)' 执行的结果返回的是'view类的as_view方法的内存函数view'
2.进入内层函数view方法内发现其返回的是as_view类的dispatch方法
def view(request, *args, **kwargs):
        return self.dispatch(request, *args, **kwargs)
3.研究dispatch方法
    def dispatch(self, request, *args, **kwargs):
        # 把请求方法转小写并判断是否存在http_method_names表内
" http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']"
        if request.method.lower() in self.http_method_names:
            # 存在则按反射按字符串去对象中拿到该方法，
            handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
        else:
            handler = self.http_method_not_allowed
        #通过反射拿到对象的方法+括号并传入request
        return handler(request, *args, **kwargs)

posted @ 2023-01-31 14:35 李阿鸡阅读(33) 评论(0) 编辑收藏举报

刷新页面返回顶部

LiaJi

DRF