Web应用模式、API接口、接口测试工具postman、restful规范、序列化反序列化、基于django原生编写5个接口、drf介绍和快速使用、CBV源码分析

目录

1.Web应用模式

在我们之前所学习的Django框架，就是专门用来写Web项目的

在开发Web应用中，有两种应用模式

  • 1.前后端混合

    客户端看到的内容和所有界面效果都是由服务端提供出来的

    img

  • 2.前后端分离

    把前端的界面效果(html，css，js)分离到另一个服务端，python服务端只需要返回数据即可

    前端形成一个独立的网站，服务端构成一个独立的网站

    image

2.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

3.接口测试工具postman

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

# 写的接口，需要有个工具测试    
	-浏览器只能发送get请求，不能自动发送post，delete请求
    -postman---》开源软件，只是谷歌浏览器的插件，越做好好，后来可以按装到操作系统上，再后来，收费
    -postwoman
    -很多很多其他的，不同公司用的也可能不一样，你只需要明白一个点，这个工具只是用来发送http请求

postman的使用

  1. 官方下载：https://www.postman.com/downloads/?utm_source=postman-home
  2. 安装，双击即可
    image
    image
    image

4.restful规范

restful全称是Representational State Transfer，中文意思是表述：表征性状态转移，它首次出现在2000年Roy Fielding的博士论文中RESTful是一种定义Web API接口设计风格，尤其适用于券后端分离的应用模式中

RESTful规范有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:101}	
            
8.返回数据中带错误信息
	{
        code:0
        msg: "ok/用户名错误"
    }
    
9.返回的结果应该不符合以下规范【公司可以不遵循这个】
	GET 获取所有数据：返回资源对象的列表(数组)	[{},{},{}]
    GET 单个对象：返回单个资源对象	{}
    POST 新增对象：返回新生成的资源对象	{}
    PUT 修改对象：返回完整的资源对象	{}
    DELETE 删除：返回一个空文档

10.响应数据中带链接
	{"link": {
      "rel":   "collection https://www.example.com/zoos",
      "href":  "https://api.example.com/zoos",
      "title": "List of zoos",
      "type":  "application/vnd.yourformat+json"
    }}

5.序列化反序列化

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

序列化

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

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

反序列化

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

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

6.基于django原生编写5个接口

我们所写的接口基本上都是5个接口及其变形

查询所有	get请求
查询单个	get请求
新增一个	POST请求
修改一个	PUT请求
删除一个	DELETE请求

基于books单表为例，写5个接口

创建book表
表迁移
录入假数据：直接录，后台管理录
写查询所有接口---》遵循restful规范，使用CBV
新增一个数据
查询一个数据
修改一个数据：put提交的数据，不能从requests.POST中取
删除一个
models 
from django.db import models


class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)
    publish = models.CharField(max_length=32)
views 
from django.shortcuts import render, HttpResponse

from django.http import JsonResponse
from .models import Book
from django.views import View

import json


class BookView(View):
    # 查询所有
    def get(self, request):
        # 查询出所有图书,queryset对象，不能直接给前端
        books = Book.objects.all()
        # 转成json格式，给前端
        # 把queryset对象转成列表，然后再使用JsonResponse
        book_list = []
        for book in books:
            book_list.append({'name': book.name, 'price': book.price, 'publish': book.publish})

        # 拓展做了解
        # return HttpResponse(json.dumps(book_list,ensure_ascii=False)) # 指定ensure_ascii为false，前端就显示中文了
        return JsonResponse(book_list, safe=False, json_dumps_params={'ensure_ascii': False})  # JsonResponse只能放字典或列表

    # 新增一个(只能使用urlencoded或form-data编码，使用json形式编码不行，因为json格式编码提交的数据，不能从request.POST中取，从body中)
    def post(self, request):
        # 取出前端传入的数据
        name = request.POST.get('name')
        price = request.POST.get('price')
        publish = request.POST.get('publish')
        # 存到数据库中
        book = Book.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 = 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只能取post提交的urlencoded或form-data编码数据，put提交的取不到
        # 查到要改的
        book = Book.objects.filter(pk=pk).first()
        # 取出前端传入的数据，修改完，保存-----》存在问题，因为put提交的取不到
        book.name = request.POST.get('name')
        book.price = request.POST.get('price')
        book.publish = request.POST.get('publish')
        book.save()

        # 前端使用json格式提交，自己保存
        print(request.body)
        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={})
urls 
urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/v1/books/', views.BookView.as_view()),
]

7.drf介绍和快速使用

djangorestframework:
    drf 帮助我们快速的实现符合restful规范的接口
    # django 最新 4.x ，一般都会用最新版的上一版3.x
	# drf最新支持到djagno 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
# urlpatterns += router.urls会自动生成五个接口

8.CBV源码分析

# 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-30 16:57  dear丹  阅读(97)  评论(0)  编辑  收藏  举报