热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

1223drf引入以及restful规范

[toc]前后台的数据交互前台安装axios插件,进行与后台的数据交互安装axios,并在main.js中设置params传递拼接参数data携带数据包参数headers中发送头部


目录




  • 前后台的数据交互

  • drf

    • 知识点概括

    • 1. 框架安装

    • 2. 接口

      • 2.1 什么是接口

      • 2.2 接口文档

      • 2.3 接口工具的使用

      • 2.4 restful接口规范


    • debug的使用





前后台的数据交互

前台安装axios插件,进行与后台的数据交互



  • 安装axios,并在main.js中设置

  • params传递拼接参数

  • data携带数据包参数

  • headers中发送头部信息,但是必须使用authorization才能携带

后台进行接受参数



  • 必须设置cors

  • headers信息使用META中HTTP_AUTHORIZATION接收

def test(request):
print(request.method)
print(request.GET) # 获取拼接参数
print(request.body) # 获取数据包参数
# 获取前端的headers信息 必需在META中HTTP_AUTHORIZATION接收
print(request.META.get('HTTP_AUTHORIZATION'))
return JsonResponse('ok',safe=False)

自定义请求头数据META

在django中settings中设置
前端发送的请求头数据,都会在META中存放,包括自定义的请求头数据
后台获取: request.META.get('HTTP_参数名全大写')

CORS_ALLOW_HEADERS = [
"accept",
"accept-encoding",
"authorization",
"content-type",
"dnt",
"origin",
"user-agent",
"x-csrftoken",
"x-requested-with",
# 自定义的请求头接受数据
"token",
"owen",
]

drf

知识点概括

全称: Django-restframework
## 1.接口
* 接口的概念
* 数据接口文档
* 接口规范(restful)
* Postman接口测试工具
## 2.drf请求周期
## 3.drf的基础组件
* 请求
* 响应
* 渲染
* 解析
* 异常
## 4.drf的序列化(核心)
* 序列化
* 模型序列化
* 群操作序列化
## 5.drf的视图家族
* 视图类(常用)
* 视图工具类
* 工具视图类(常用)
* 视图集
## 6.drf的三大认证(核心)
* 认证
* 权限
* 频率
## 7.drf的过滤
* 筛选
* 搜索
* 排序
* 分页
* 区间

1. 框架安装



  • drf是Django的框架,所以要提前安装Django

  • 安装命令: pip install djangorestframework

  • 使用drf时,要在settings中注册


2. 接口


2.1 什么是接口

规定了提交请求参数的请求方式,访问其可以获取响应的反馈数据的url链接

四部分:
url链接 + 请求方式 + 请求参数 + 响应数据

小猿取经https://www.cnblogs.com/xiaoyuanqujing/articles/11869745.html

返回网页的叫网址,返回数据的叫做接口

2.2 接口文档

编写接口文档,使用yapi

详情见小猿取经


2.3 接口工具的使用

将接口使用postman进行测试

postman网址

6E823f587c95f0148c19993539b99295

技术分享图片


2.4 restful接口规范


1. url链接



  • 通常采用https协议

    接口都是操作前后台数据的,所以需要保证数据的安全性


  • 使用api关键字标识接口url

    接口用来操作数据,与网址(操作页面)有区别,所以用特定的关键字表示接口
    - https://api.baidu.com
    - https://www.baidu.com/api


  • 通常使用资源的复数形式,不要出现操作资源的动词

    接口操作的数据称之为`资源`,在url中只体现 `资源名称(名词)`,不体现`操作资源的方式(动词)`
    常规资源接口
    - https://api.baidu.com/books/
    - https://api.baidu.com/books/(pk)/
    非常规接口
    - 和某资源不是特别密切或是不止一种资源
    - https://api.baidu.com/login/
    - https://api.baidu.com/place/search


  • 在url链接中标识数据版本

    如果一个资源存在多版本结果,在url链接中要用特定的符号来兼容多版本共存
    v1|v2
    - https://api.baidu.com/v1/books/
    - https://api.baidu.com/v1/books/


  • 群资源操作,一般还有额外的限制条件,如排序,限制调试,分页等等

    ?限制条件
    - https://api.baidu.com/v1/books/?ordering=-price&limit=3
    按照价格降序,并且只显示3本



2. 五大请求方式



  • get: 获取单个或者多个资源

    群查,返回多个结果对象
    - https://api.baidu.com/books/
    单查,返回单个结果对象
    - https://api.baidu.com/books/(pk)/


  • post: 新增单个或多个资源

    - https://api.baidu.com/books/
    单增,提交单个数据字典,完成单增,返回单个结果对象
    群增,提供多个数据字典的数组,完成群增,返回多个结果对象


  • put :整体修改单个或多个资源

    - https://api.baidu.com/books/
    整体修改多个,提供多个数据字典的数组(数据字典中要包含主键),完成群改,返回多个结果对象
    - https://api.baidu.com/books/(pk)/
    整体修改单个,提供单个数据字典(主键在url中体现),完成单改,返回单个结果对象


  • patch : 局部修改单个或多个资源

    方式与put完全相同,不同的是:
    操作的资源如果有5个key-value键值对,put请求提供的字典必须全包含,但是patch提供的字典包含的键值对0~5个都可以


  • delete :删除单个或多个资源

    - https://api.baidu.com/books/
    多删,提供多个资源主键数据,完成群删,不做任何资源返回(但一般我们会返回结果信息:成功|失败)
    - https://api.baidu.com/books/(pk)/
    单删,不需要提供额外数据,完成单删除,不做任何资源返回(但一般我们会返回结果信息:成功|失败)



3. 响应结果



  • 网络状态码:

    网络状态信息和网络状态码捆绑出现,不要额外设置
    1xx:基本信息
    2xx: 成功
    -200 基本
    -201 新增成功
    3xx:重定向
    4xx: 客户端错误
    - 400 错误请求
    - 403 请求无权限
    - 404 请求资源不存在
    5xx: 服务端错误
    - 500 服务器错误


  • 数据状态码(一般都是前后台约定规则)

    0: 成功
    1: 失败
    1xx: 具体失败信息(要在接口文档中明确写出)
    2: 无数据
    2xx: 具体无数据信息(要在接口文档中明确写出)


  • 数据状态信息

    一般不仅仅是对数据状态码的解释,更多的是对结果的描述,给前台开发者阅读的


  • 数据结果

    常量数组字典,如果有子资源(图片,音频,视频),返回资源的url连接

    {
    'status':0,
    'msg':'ok',
    'results':[{
    'name':'西游记,
    'img':'https://api.baidu.com/book/xyj.png'
    }]
    }



debug的使用

技术分享图片

views.py

查询数据的方式

# 一个视图类可以包含常规五个请求方法
# 五个请求方法处理是个资源操作的逻辑
class BookView(View):
# 单查数据
def _single_get(self,pk):
book_dic = models.Book.objects.filter(pk=pk).values('name','price').first()
if not book_dic:
return JsonResponse({
'static': 1,
'msg': '单查资源不存在',
})
return JsonResponse({
'static':0,
'msg':'单查ok',
'results':book_dic
})
# 群查数据
def _many_get(self):
book_query = models.Book.objects.values('name','price')
book_list = list(book_query)
return JsonResponse({
'static':0,
'msg':'群差ok',
'results':book_list
})
# 查询数据
def get(self,request,*args,**kwargs):
pk = kwargs.get('pk')
if pk:
return self._single_get(pk)
else:
return self._many_get()


推荐阅读
  • 本文介绍了lua语言中闭包的特性及其在模式匹配、日期处理、编译和模块化等方面的应用。lua中的闭包是严格遵循词法定界的第一类值,函数可以作为变量自由传递,也可以作为参数传递给其他函数。这些特性使得lua语言具有极大的灵活性,为程序开发带来了便利。 ... [详细]
  • 基于layUI的图片上传前预览功能的2种实现方式
    本文介绍了基于layUI的图片上传前预览功能的两种实现方式:一种是使用blob+FileReader,另一种是使用layUI自带的参数。通过选择文件后点击文件名,在页面中间弹窗内预览图片。其中,layUI自带的参数实现了图片预览功能。该功能依赖于layUI的上传模块,并使用了blob和FileReader来读取本地文件并获取图像的base64编码。点击文件名时会执行See()函数。摘要长度为169字。 ... [详细]
  • 本文介绍了使用Java实现大数乘法的分治算法,包括输入数据的处理、普通大数乘法的结果和Karatsuba大数乘法的结果。通过改变long类型可以适应不同范围的大数乘法计算。 ... [详细]
  • HDU 2372 El Dorado(DP)的最长上升子序列长度求解方法
    本文介绍了解决HDU 2372 El Dorado问题的一种动态规划方法,通过循环k的方式求解最长上升子序列的长度。具体实现过程包括初始化dp数组、读取数列、计算最长上升子序列长度等步骤。 ... [详细]
  • 本文讨论了Alink回归预测的不完善问题,指出目前主要针对Python做案例,对其他语言支持不足。同时介绍了pom.xml文件的基本结构和使用方法,以及Maven的相关知识。最后,对Alink回归预测的未来发展提出了期待。 ... [详细]
  • 本文讨论了如何优化解决hdu 1003 java题目的动态规划方法,通过分析加法规则和最大和的性质,提出了一种优化的思路。具体方法是,当从1加到n为负时,即sum(1,n)sum(n,s),可以继续加法计算。同时,还考虑了两种特殊情况:都是负数的情况和有0的情况。最后,通过使用Scanner类来获取输入数据。 ... [详细]
  • 本文介绍了C#中数据集DataSet对象的使用及相关方法详解,包括DataSet对象的概述、与数据关系对象的互联、Rows集合和Columns集合的组成,以及DataSet对象常用的方法之一——Merge方法的使用。通过本文的阅读,读者可以了解到DataSet对象在C#中的重要性和使用方法。 ... [详细]
  • 本文介绍了OC学习笔记中的@property和@synthesize,包括属性的定义和合成的使用方法。通过示例代码详细讲解了@property和@synthesize的作用和用法。 ... [详细]
  • Mac OS 升级到11.2.2 Eclipse打不开了,报错Failed to create the Java Virtual Machine
    本文介绍了在Mac OS升级到11.2.2版本后,使用Eclipse打开时出现报错Failed to create the Java Virtual Machine的问题,并提供了解决方法。 ... [详细]
  • 在说Hibernate映射前,我们先来了解下对象关系映射ORM。ORM的实现思想就是将关系数据库中表的数据映射成对象,以对象的形式展现。这样开发人员就可以把对数据库的操作转化为对 ... [详细]
  • 本文介绍了在SpringBoot中集成thymeleaf前端模版的配置步骤,包括在application.properties配置文件中添加thymeleaf的配置信息,引入thymeleaf的jar包,以及创建PageController并添加index方法。 ... [详细]
  • 知识图谱——机器大脑中的知识库
    本文介绍了知识图谱在机器大脑中的应用,以及搜索引擎在知识图谱方面的发展。以谷歌知识图谱为例,说明了知识图谱的智能化特点。通过搜索引擎用户可以获取更加智能化的答案,如搜索关键词"Marie Curie",会得到居里夫人的详细信息以及与之相关的历史人物。知识图谱的出现引起了搜索引擎行业的变革,不仅美国的微软必应,中国的百度、搜狗等搜索引擎公司也纷纷推出了自己的知识图谱。 ... [详细]
  • 本文讲述了作者通过点火测试男友的性格和承受能力,以考验婚姻问题。作者故意不安慰男友并再次点火,观察他的反应。这个行为是善意的玩人,旨在了解男友的性格和避免婚姻问题。 ... [详细]
  • 本文详细介绍了Linux中进程控制块PCBtask_struct结构体的结构和作用,包括进程状态、进程号、待处理信号、进程地址空间、调度标志、锁深度、基本时间片、调度策略以及内存管理信息等方面的内容。阅读本文可以更加深入地了解Linux进程管理的原理和机制。 ... [详细]
  • 本文介绍了在开发Android新闻App时,搭建本地服务器的步骤。通过使用XAMPP软件,可以一键式搭建起开发环境,包括Apache、MySQL、PHP、PERL。在本地服务器上新建数据库和表,并设置相应的属性。最后,给出了创建new表的SQL语句。这个教程适合初学者参考。 ... [详细]
author-avatar
toto333
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有