目录
- 1. 前后端开发模式
- 2. API接口
- 3. 接口测试工具postman
- 4. RESTful API规范
- 5. 序列化和反序列化
- 6. Django Rest_Framework快速使用(模拟)
- 7. cbv源码分析
1. 前后端开发模式
1.1 前后端混合开发
模块
使用模板语法渲染模板,后端人员要通过前端写好的html页面,套模板语法
eg: 图书管理系统,BBS项目,
过程:
前端写好静态的HTML页面交付给后端开发。静态页面可以本地开发,也无需考虑业务逻辑只需要实现View即可。
后端使用模板引擎去套模板,同时内嵌一些后端提供的模板变量和一些逻辑操作。
然后前后端集成对接,遇到问题,前台返工,后台返工。
然后在集成,直至集成成功。
1.2 前后端分离
过程:
后端任人员只负责写接口(API接口),使用postman接口测试工具测试
前端人员负责写前端,写的过程中使用mock数据
最后:前后端联调项目
优点:
为优质产品打造精益团队
提高开发效率
完美应对复杂多变的前端需求
增强代码可维护性
1.3 流程图
前后端不分离
前后端分离
1.4 前端的后台管理模板
xadmin : 前端的后台管理模板:layui+jquery 国人 贤心
admin-lte:前端的后台管理模板:bootstrap+jquery 老外
2. API接口
2.1 本质
通过网络,规定了前后台信息交互规则的url链接,也就是前后台信息交互的媒介
2.2 四大特点
1. url:长得像返回数据的url链接
https://api.map.baidu.com/place/v2/search
2. 请求方式L:get、post、put、patch、delete
采用get方式请求上方接口
3. 请求参数:json或xml格式的key-value数据类型数据
ak:6E823f587c95f0148c19993539b99295
region:上海
query:肯德基
output:json
4. 响应结果:json或xml格式的数据
请求参数的output参数值决定了响应数据的格式
2.3 模拟
# xml格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295®ion=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml
#json格式
https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295®ion=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json
3. 接口测试工具postman
API接口写好,后端人员要测试,不可能在浏览器里测试
使用postman软件,来做接口测试。本质就是:模拟发送http请求
接口测试软件有很多:postwoman,postman(Apipost = Postman + Swagger + Mock + Jmeter)
官网下载:https://www.postman.com/downloads/
4. RESTful API规范
4.1 本质应用
1. REST全称是Representational State Transfer,中文意思是表述:表征性状态转移, 它首次出现在2000年Roy Fielding的博士论文中
2. RESTful是一种定义Web API接口的设计风格,尤其适用于前后端分离的应用模式中,这种风格的理念认为后端开发任务就是提供数据的,对外提供的是数据资源的访问接口,所以在定义接口时,客户端访问的URL路径就表示这种要操作的数据资源。事实上,我们可以使用任何一个框架都可以实现符合restful规范的API接口。
3. restful规范有10点规范,公司有自己的风格规范
4.2 规范有10点
4.2.1 数据的安全保障
url链接一般都采用https协议进行传输
为了保证数据安全使用
https是什么:http+ssl/tsl
4.2.2 接口中携带api关键词
https://api.baidu.com
https://www.baidu.com/api
看到api字眼,就代表该请求url链接是完成前后台数据交互的
4.2.3 多数据版本共存
一个接口可能有多个版本,url链接中标识版本标识
https://api.baidu.com/v1
https://api.baidu.com/v2
url链接中的v1、v2就是不同数据版本的体现
eg:假设咱们有个登录接口:开始只要用户名和密码 后来用户名,密码,验证码
4.2.4 数据即是资源,均使用名词(可用复数)
接口尽量使用名词,都是用名词,
没法区分是增加,删除,修改,查询
4.2.5 资源操作由请求方式决定
获取数据:get请求
删除数据:delete请求
新增数据:post请求
修改数据:put,patch请求
请求地址一样,通过请求方式决定对资源进行什么操作
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的书
4.2.6 url地址中带过滤参数
获取动物园所有动物 127.0.0.1/api/v1/animals get请求
获取动物园所有哺乳类动物 127.0.0.1/api/v1/animals?type=哺乳类 get请求
4.2.7 响应带状态码
http状态码:http://tools.jb51.net/table/http_status_code
1xx:表示请求正在处理,一般看不到
2xx:表示请求处理成功, 有很多 200,201
200:常规请求
201:创建成功
3xx:重定向 302 301
301:永久重定向
302:暂时重定向
4xx:客户端错误 403 404
403:请求无权限
404:请求路径不存在
405:请求方法不存在
5xx:服务端错误
500:服务器异常
4.2.8 错误处理,应返回错误信息,error当做key
{
error: "无权限操作"
}
4.2.9 返回结果,针对不同操作,服务器向用户返回的结果应该符合以下规范
GET /collection:返回资源对象的列表(数组)
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档
获取所有:{code:100,msg:成功,data:[{name:三国,price:99},{name:西游记,price:88}]}
获取单条:{code:100,msg:成功,data:{name:三国,price:99}}
新增数据:{code:100,msg:新增成功,data:{name:西游记,price:99}}
修改数据:{code:100,msg:修改成功,data:{name:西游记v2版本,price:99}}
删除数据:{code:100,msg:删除成功}
4.2.10 响应中带链接
Hypermedia API,RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么
5. 序列化和反序列化
api接口开发,最核心最常见的一个过程就是序列化,所谓序列化就是把数据转换格式,序列化可以分两个阶段:
**序列化**: 把我们识别的数据转换成指定的格式提供给别人。
例如:我们在django中获取到的数据默认是模型对象,但是模型对象数据无法直接提供给前端或别的平台使用,所以我们需要把数据进行序列化,变成字符串或者json数据,提供给别人。
**反序列化**:把别人提供的数据转换/还原成我们需要的格式。
例如:前端js提供过来的json数据,对于python而言就是字符串,我们需要进行反序列化换成模型类对象,这样我们才能把数据保存到数据库中。
6. Django Rest_Framework快速使用(模拟)
6.1 简介
核心思想: 缩减编写api接口的代码
Django REST framework是一个建立在Django基础之上的Web 应用开发框架,可以快速的开发REST API接口应用。在REST framework中,提供了序列化器Serialzier的定义,可以帮助我们简化序列化与反序列化的过程,不仅如此,还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework提供了一个API 的Web可视化界面来方便查看测试接口。
官方文档:https://www.django-rest-framework.org/
github: https://github.com/encode/django-rest-framework/tree/master
6.2 接口:总共就5个及5个的变形
获取所有 get
获取单个 get
新增一条 post
修改一条 put/patch
删除一条 delete
6.3 代码模拟
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)
serializer.py
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book
fields = '__all__'
7. 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)
标签:01,请求,4.2,接口,Django,api,rest,https,序列化
From: https://www.cnblogs.com/cainiaozhy/p/16724445.html