文章目录
一、前后端开发模式二、API接口三、接口测试工具Postman四、Restful规范五、序列化反序列化六、DjangoRestFramework快速使用七、CBV源码分析
一、前后端开发模式
在开发Web应用的时候 总共有两种应用模式 前后端不分离、前后端分离 前后端分离是目前一种流行的开发模式 会使得项目分工明确 后端负责处理存储数据 前端负责显示数据 前端和后端开发人员通过API接口 进行数据的交互 开发完成后联调和提交测试 那如果需要数据测试呢？ 前端可以使用Mock平台来模拟接口数据 后端使用软件Postman模拟前端发送请求
二、API接口
API全称（Application Programming Interface）规定了前后端信息交互规则的URL链接简单来说就是前后端信息交互的媒介
URL样式：http://localhost:8080/user?id=1 请求方式：Get获取所有、Post新增、Put修改、Patch修改、Delete删除 请求参数：Json或Xml格式的Key:Value类型数据
{
"reason": "查询成功",
"result": {
"city": "上海",
"realtime": {
"temperature": "4",
"humidity": "82",
"info": "阴",
"wid": "02",
"direct": "西北风",
"power": "3级",
"aqi": "80"
},
"future": [
{
"date": "2020-09-24",
"temperature": "1/7℃",
"weather": "小雨转多云",
"wid": {
"day": "07",
"night": "01"
},
"direct": "北风转西北风"
},
抽象比喻 假如老刘开了一家银行，银行只有仓库和记账本，顾客来了之后将金钱放在仓库里并在记帐本上记帐。 老王很快就意识到一个问题：这个存钱的人存在打不开仓库、不认识字、写错存放金额的问题。 于是老刘雇佣了一个员工小纪，并给银行加了一个柜台，这样顾客就可以直接把金钱交给小纪。小纪记录好之后给顾客收据，并把金币存放在仓库中。 在这里老刘雇佣了小纪来完成记帐存钱取钱等繁琐的任务，这节省了用户的时间，也提高了银行工作的效率。如果我们把这具体的事情抽象化，那代替小纪的角色就是API，很大的节省了开发人员的负担，提高了效率。 柜台将银行分为两个区域：客户在前台办理业务，后台进行存款取款等操作。在柜台，前台和后台进行了交互，双方不能越界。从API的属于来说，柜台就是术语中的API的接口，在这里完成交互。
三、接口测试工具Postman
后端测试人员需要测试API接口的时候 总不可能在浏览器里面试用吧 所以有了专业的接口测试工具Postman 使用Postman软件来测试接口 本质就是发送Http请求官网下载（https://www.postman.com/downloads/） 接口测试软件有很多： Postman、Eolink、SoapUI、JMeter、REST-Assured
四、Restful规范
REST全称是Representational State Transfer 中文意思是表述（编者注：通常译为表征性状态转移）是一种Web服务的软件架构风格 它首次出现在2000年Roy Fielding的博士论文中 RESTful是一种定义Web API接口的设计风格 尤其适用于前后端分离的应用模式中 这种风格的理念认为后端开发任务就是提供数据的 对外提供的是数据资源的访问接口，所以在定义接口时 客户端访问的URL路径就表示这种要操作的数据资源 事实上我们可以使用任何一个框架都可以实现符合restful规范的API接口
1. 数据的安全保障
URL链接一般都采用Https协议进行传输 采用Https协议 可以提高数据交互过程中的安全性
2. 接口特征表现
用api关键字标识接口URL https://api.baidu.com(看到API字眼 就代表该请求URL链接是完成前后端数据交互的)
3. 多数据版本共存
在URL链接中标识数据版本 https://api.baidu.com/v1(URL链接中的v1就是不同数据版本的体现）
4. 数据即是资源 均使用名词（可复数）
接口一般都是完成前后端数据的交互 交互的数据我们称之为资源https://api.baidu.com/users 、https://api.baidu.com/books
一般提倡用资源的复数形式 在URL链接中不要出现操作资源的动词 错误示范：https://api.baidu.com/delete-user
特殊的接口可以出现动词 因为这些接口一般没有一个明确的资源 或是动词就是接口的核心含义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 - patch请求：局部修改主键为1的书
https://api.baidu.com/books/1 - delete请求：删除主键为1的书
6. 过滤 通过在url上传参的形式传递搜索条件
https://api.example.com/v1/zoos?limit=10： 指定返回记录的数量
https://api.example.com/v1/zoos?offset=10： 指定返回记录的开始位置
https://api.example.com/v1/zoos?page=2&per_page=100： 指定第几页，以及每页的记录数
https://api.example.com/v1/zoos?sortby=name&order=asc： 指定返回结果按照哪个属性排序，以及排序顺序
https://api.example.com/v1/zoos?animal_type_id=1： 指定筛选条件
7. 响应状态码
响应状态码2XX 200:常规请求 201:创建成功
响应状态码3XX 301:永久重定向 302:暂时重定向
响应状态码4XX 403:请求无权限 404:请求路径不存在 405:请求方法不存在
响应状态码5XX 500:服务器异常
8. 错误处理 应返回错误信息 error当做key
{ error:"无权限操作" }
9. 返回结果 针对不同操作 服务器向用户返回的结果应该符合以下规范
GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档
10.需要url请求的资源需要访问资源的请求链接
# Hypermedia API RESTful API最好做到Hypermedia
即返回结果中提供链接 连向其他API方法 使得用户不查文档 也知道下一步应该做什么
{
"status": 0,
"msg": "ok",
"results":[
{
"name":"肯德基(罗餐厅)",
"img": "https://image.baidu.com/kfc/001.png"
}
...
]
}
比较好的接口返回
# 响应数据要有状态码、状态信息以及数据本身
{
"status": 0,
"msg": "ok",
"results":[
{
"name":"肯德基(罗餐厅)",
"location":{
"lat":31.415354,
"lng":121.357339
},
"address":"月罗路2380号",
"province":"上海市",
"city":"上海市",
"area":"宝山区",
"street_id":"339ed41ae1d6dc320a5cb37c",
"telephone":"(021)56761006",
"detail":1,
"uid":"339ed41ae1d6dc320a5cb37c"
}
...
]
}
五、序列化反序列化
涉及到API接口开发 那就要说到序列化了 前后端数据的交互如果直接给到对方会出现报错 两种语言是不能相互使用的 所以就有了中间人序列化 API最核心最常见的一个过程就是序列化 所谓序列化就是把数据转换格式 序列化分为两个阶段:
序列化: 把我们识别的数据转换成指定的格式提供给别人
反序列化：把别人提供的数据转换成我们需要的格式数据
六、DjangoRestFramework快速使用
Django REST Framework是一个建立在Django基础之上的Web应用开发框架 可以快速的开发REST API接口应用 在DjangoRestFramework中提供了序列化器Serialzier的定义 可以帮助我们简化序列化与反序列化的过程 还提供丰富的类视图、扩展类、视图集来简化视图的编写工作DjangoRestFramework还提供了认证、权限、限流、过滤、分页、接口文档等功能的支持 DjangoRestFramework提供了一个API 的Web可视化界面来方便查看测试接口
我们在写原生的前后端分离项目是使用的是Django的Web框架(只写接口 使用JsonResponse返回即可) 但是想让前后端分离更方便就可以用到DjangoRestFramework可以方便我们快速写出符合Restful规范的接口
写接口总共就五个及五个的变形就是我们上面写到的
GET 获取所有 GET 获取单个 POST 新增一条 PUT 修改 PATCH 修改 DELETE 删除
对于我们原生的Django需要去单独写这五个增删改查接口 但是使用DRF就能让你知道什么是快了！！！
安装DRF: pip3 install djangorestframework
urls.py
from django.contrib import admin
from django.urls import path
from rest_framework.routers import SimpleRouter
from app01 import views
router = SimpleRouter()
router.register('books', views.BookView)
urlpatterns = [
path('admin/', admin.site.urls),
]
urlpatterns += router.urls
views.py
from .models import Book
from rest_framework.viewsets import ModelViewSet
from .serializer import BookSerializer
class BookView(ModelViewSet):
queryset = Book.objects.all()
serializer_class = BookSerializer
models.py
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)
'''记得迁移命令 maemigrations migrate'''
serializer.py
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book
fields = '__all__'
'''
获取所有图书：Get http://127.0.0.1:8000/books/
获取单个图书：Get http://127.0.0.1:8000/books/1/ 加上ID号
新增数据： POST http://127.0.0.1:8000/books/ Body内写入数据
删除数据： DeLETE http://127.0.0.1:8000/books/1/ 加上ID号
修改数据： PUT http://127.0.0.1:8000/books/2/?name=你问我为什么&price=999&publish=在家出版社
就是这么简单快速 五个接口就立马写好了 这是DRF的速度
'''
七、CBV源码分析
# cbv写好后，路由配置如下
-第一个参数是路径，第二个参数是试图函数的内存地址（视图类执行as_view这个类方法，把它执行完，结果放在第二个参数上：我们猜执行完的结果是个函数内存地址）
path('test/', views.TestView.as_view()),
-去找as_view，去TestView类中找，找不到，没有，去父类中找View
@classonlymethod
def as_view(cls, **initkwargs):
def view(request, *args, **kwargs):
return self.dispatch(request, *args, **kwargs)
return view
-当请求来了，路由匹配成功，会执行view(request)--->本质执行self.dispatch(request, *args, **kwargs)
-去View中找到了dispatch
def dispatch(self, request, *args, **kwargs):
# 请求方式转成小写，假设 get 请求，符合if条件
if request.method.lower() in self.http_method_names:
# 反射 getattr(对象,'字符串','默认值')
# self是TestView的对象
# handler 就是TestView类的get方法
handler = getattr(self, 'get', self.http_method_not_allowed)
else:
handler = self.http_method_not_allowed
return handler(request, *args, **kwargs) # get(request)
技术小白记录学习过程，有错误或不解的地方请指出，如果这篇文章对你有所帮助请点点赞收藏+关注谢谢支持 !!!
文章来源
您阅读本篇文章共花了：
发表评论