首页 > 编程语言 >前后端开发模式、API接口、接口测试工具postman、restful规范、序列化和反序列化、djangorestframework快速使用、cbv源码分析

前后端开发模式、API接口、接口测试工具postman、restful规范、序列化和反序列化、djangorestframework快速使用、cbv源码分析

时间:2022-09-23 20:35:59浏览次数:109  
标签:接口 api https 测试工具 序列化 com example

目录

# 老刘的博客
# 个人博客:
https://liuqingzheng.top/python/Python%E7%B3%BB%E5%88%97%E6%95%99%E7%A8%8B/
    
# cnblogs博客:
https://www.cnblogs.com/liuqingzheng

# 知乎:
https://www.zhihu.com/people/justin_liu/posts

前后端开发模式

一、两种模式

1.传统开发模式:前后端混合开发

  • 使用模板语法渲染模板

  • 后端人员要通过前端写好的html页面,套模板语法

1.1.缺点:

  • 要求后端人员会html、js等一些前端语言;前端页面会嵌入后端的代码,一旦后端换了另外一种语言开发,几乎就要重做。

  • 增加了大量的沟通成本、调试成本,而且前后端开发进度互相影响,降低了开发效率

例子
图书管理系统
bbs项目

2.前后端分离开发模式

  • 后端人员只负责写接口(API接口),使用postman接口测试工具测试
  • 前端人员负责写前端,写的过程中使用mock数据(Mock测试:构造虚拟的测试对象,来简化测试环境的方法,能够支持前端的独立开发和测试)
  • 最后:前后端联调项目

2.1.特点

1.客户端和服务器采用RESTFul API的交互方式进行交互
2.前后端代码库分离
3.并行开发

3.补充

老刘的相关博客:

https://www.cnblogs.com/liuqingzheng/p/10900502.html

xadmin:
   前端的后台管理模板:layui+jQuery  # 国人做的 贤心
    
admin-lte:
   前端的后台管理模板:bootstrap+jQuery  # 老外做的

二、API接口

1.作用

通过网络,规定了前后填信息交互规则的url链接,是前后台信息交互的媒介

ps:点赞点踩接口其实就是一个API接口

2.说明

1.url:长得像返回数据的url链接
    https://api.map.baidu.com/place/v2/search

2.请求方式:get、post、put、patch、delete
    采用get方法请求上方接口
    
3.请求参数:json或xml格式的key-value类型数据
    ak:6E823f587c95f0148c19993539b99295
    region:上海
    query:肯德基
    output:json
    响应结果:json或xml格式的数据
4.响应结果:json或xml格式的数据

三、接口测试工具postman

1.作用

API接口写好后,后端人员要测试,不可能在浏览器里测试

2.使用postman软件做接口测试的本质

模拟发送HTTP请求

3.接口测试软件有很多

postwoman:在postman收费后,仿的

4.下载

https://www.postman.com/downloads/

下载好后,双击安装即可

5.说明

四、restful规范

1.介绍

REST全称是Representational State Transfer,中文意思是表述:表征性状态转移, 它首次出现在2000年Roy Fielding的博士论文中

RESTful是一种定义Web API接口的设计风格,尤其适用于前后端分离的应用模式中

2.restful 规范十点

数据的安全保障

```python
url链接一般都采用HTTPS协议进行传输
# 为了保证数据安全使用HTTPS传输协议
# https:http+ssl/tsl
```

接口中带api关键字

```python
https://api.example.com/v1/
```

多数据版本共存,一个接口可能有多个版本

```python
	url链接中标识版本
    如:https://api.example.com/v1/
```

数据即资源,均使用名词(可用复数)

```python
https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees
都是名词,无法区分增、删、改、查
```

资源操作由请求方式决定

```python
	获取数据:get请求
	删除数据:delete请求
	新增数据:post请求
	修改数据:put、patch请求
	请求地址一样,通过请求方式决定对资源进行的操作
```

url地址中带过滤参数

```python
获取动物园所有动物   
127.0.0.1/api/v1/animals  --->get请求

获取动物园所有哺乳类动物
127.0.0.1/api/v1/animals?type=哺乳类  --->get请求

指定返回记录的数量
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
```

响应带状态码

```python
http状态码详情:	
	http://tools.jb51.net/table/http_status_code
响应体中写代码状态:
{code:100}
```
响应状态码笼统 说明
1xx 表示请求正在处理
2xx 表示请求处理成功
3xx 重定向
4xx 客户端错误
5xx 服务的错误

响应体中带错误信息

{code:100,msg:成功}

返回结果,针对不同操作,服务器向用户返回的结果应该符合一下规范

操作 返回
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:删除成功}

响应中带链接

{
	"link": {
		"rel":   "collection https://www.example.com/zoos",
		"href":  "https://api.example.com/zoos",
		"title": "List of zoos",
		"type":  "application/vnd.yourformat+json"
	}
}

五、序列化和反序列化

# api接口开发,最核心最常见的一个过程就是序列化
所谓序列化就是"把数据转换格式",序列化可以分两个阶段:
	序列化: 把我们识别的数据转换成指定的格式提供给别人
		-例如:我们在django中获取到的数据默认是模型对象(queryset),但是模型对象数据无法直接提供给前端或别的平台使用,所以我们需要把数据进行序列化,变成字符串或者json数据,提供给别人。

	反序列化:把别人提供的数据转换/还原成我们需要的格式

六、djangorestframework快速使用

# 使用django这个web框架,开发前后端分离项目(模板渲染),只写接口
	-使用JsonResponse返回即可---》原生django
    -djangorestframework方便咱们快速写出符合restful规范的接口
    
# 写接口:总共就5个及这5个的变形
	-获取所有 get
    -获取单个 get
    -新增一条 post
    -修改一条 put/patch
    -删除一条 delete
    
    
# 对于book表,快速实现这5个接口
	-使用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)

serializer.py

from rest_framework import serializers
from .models import Book


class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'

通过postman测试

七、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:   
           handler = getattr(self, 'get', self.http_method_not_allowed)
        else:
           handler = self.http_method_not_allowed
           return handler(request, *args, **kwargs)  # get(request)
    '''            
        # 反射 getattr(对象,'字符串','默认值')
        # self是TestView的对象
        # handler 就是TestView类的get方法
    '''

标签:接口,api,https,测试工具,序列化,com,example
From: https://www.cnblogs.com/Zhang614/p/16724129.html

相关文章