drf——全局处理异常、接口文档、jwt介绍、based64编码与解码

这篇具有很好参考价值的文章主要介绍了drf——全局处理异常、接口文档、jwt介绍、based64编码与解码。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

全局异常处理原理

# 对于前端来讲,后端即便报错,也要返回统一的格式,前端便于处理
{code:999,msg:'系统异常,请联系系统管理员'}

# 只要三大认证,视图类的方法出了异常,都会执行一个函数:
    rest_framework.views import exception_handler

# drf只要出了异常就会执行 这是drf的配置文件中的
    'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler'
	
"""
dispatch中处理全局异常先走response = self.handle_exception(exc)
进到handle_exception
exception_handler = self.get_exception_handler()
会去执行配置文件配置的exception_handler这个函数
"""

# 但是源码是不能改的 我们可以自定义一个函数 配置一下 以后出了异常 执行我们自己的函数
"""
需要在项目的配置文件中配置上自己写的这个函数 字典的v是函数的路径
REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'app01.excepitons.common_exception_handler',
}
"""
# 注意:exception_handler
"""
如果异常对象是drf的APIException的对象,就会返回Response
exception_handler只处理了drf的异常,其他的异常需要我们自己处理
如果异常对象不是drf的APIException对象,就会返回None
"""
# exception_handler源码:
	def exception_handler(exc, context):  # 如果有异常会走这
        if isinstance(exc, exceptions.APIException):  # 判断是否是APIException的对象 是就返回Response 不是返回None
            if isinstance(exc.detail, (list, dict)):
                data = exc.detail
            else:
                data = {'detail': exc.detail}
            return Response(data, status=exc.status_code, headers=headers)
    	return None
    
# 补充 内置方法
isinstance()  判断一个对象是不是某个类的对象 isinstance(对象,类)
issubclass()  判断一个类,是不是另一个类的子类

全局异常处理代码

# 我们自己自定义的函数

def common_exception_handler(exc,context):
    # 只要走到这里,一定出异常了,我们正常的项目要记录日志
    res = exception_handler(exc,context)
    # 两种可能:应该是Response对象,一个是None
    if res:
        if isinstance(res.data,dict)
        # 如果res有值 说明是drf的异常,它处理了
        	detail = res.data.get('detail')
        else:
            detail = res.data
        return Response({'code':999,'msg':detail})
    else:
        # 如果res没有值返回的是None 则说明是其他异常,它没有处理
        # return Response({'code': 999, 'msg': '系统异常,请联系系统管理员'})
        return Response({'code':100,'msg':str(exc)})
    
# 项目的配置文件
REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'app01.excepitons.common_exception_handler',
}

接口文档

# 后端把接口写好后
	登录接口
    注册接口
    查询所有图书带过滤接口
# 前端人员需要根据接口文档,进行前端开发

# 前后端需要做对接----》对接第一个东西就是这个接口文档---》前端照着接口文档开发
# 公司3个人,每个人开发了10个接口,3个人都要同时写接口文档

# 接口文档的编写形式
	1.word,md编写,大家都可以操作,写完放在git上或者是公司的文档管理平台上
    2.第三方的接口文档平台(收费)
    	https://www.showdoc.com.cn/
    3.公司自己开发接口文档平台
    4.公司使用开源的接口文档平台,搭建
    	-YAPI:百度开源的
        -https://zhuanlan.zhihu.com/p/366025001 # 如何搭建
    5.项目自动生成接口文档
    	5.1 coreapi
        5.2 swagger
        
# 使用coreapi自动生成接口文档
	使用步骤:
    	1. 安装:pip38 install coreapi
        2.加一个路由
        	from rest_framework.documentation import include_docs_urls
            urlpatterns = [
                path('docs/',include_docs_urls(title='站点页面标题'))
            ]
        3.在视图类上加注释
       	4.配置文件中配置
        'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema'
        5.表模型或序列化类的字段上写 help_text--->会显示在接口文档的字段介绍上
        6.访问地址:
        	http://127.0.0.1:8000/docs/

jwt介绍和原理

# https://www.cnblogs.com/liuqingzheng/p/16154439.html

# cookie,session,token发展历史
	会话管理
    cookie:客户端浏览器的键值对
    session:服务端的键值对(djangosession表,内存中,文件,缓存数据库)
    token:服务端生成的加密字符串,如果存在客户端浏览器上,就叫cookie
    	三部分:头,荷载,签名
        签发:登录成功,签发
        认证:认证类中认证
        
# jwt:Json web token (JWT),web方向的token认证
	长得样子:   eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

drf——全局处理异常、接口文档、jwt介绍、based64编码与解码文章来源地址https://www.toymoban.com/news/detail-461041.html

base64编码和解码

# base64并不是一种加密反射,只是编码解码方式
# 字符串,可以转成base64编码格式:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
# eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 解码成base64

import json
import base64

d = {'user_id':1,'username':'lqz'}
d_str = json.dumps(d)
# print(d_str)
# 对字符串进行base64 编码
res = base64.b64encode(bytes(d_str,encoding='utf-8'))
print(res)  # b'eyJ1c2VyX2lkIjogMSwgInVzZXJuYW1lIjogImxxeiJ9'
# 解码
res = base64.b64decode(res)
print(res)
# 括号内也可以直接放一串字符串 长度必须是4的倍数 长度不够时用=补齐
res = base64.b64decode('TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ=')
print(res)

# base64的用途
"""
1.在互联网中 前后端数据交互使用base64编码
2.jwt 字符串使用base64编码
3.互联网中一些图片 使用base64编码
"""

到了这里,关于drf——全局处理异常、接口文档、jwt介绍、based64编码与解码的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • python标准模块介绍 -Base64: Base64, Base85等数据编码

    功能:RFC 3548: Base16, Base32, Base64 数据编码。转换二进制数据为适合明文协议传输的 ASCII 序列。转换 8bits 为每个字节包含 6,5 或 4bits 的有效数据,比如 SMTP, URL 的一部分或者 HTTP POST 的一部分。参考: RFC 3548。编码算法不同于 uuencode。 类型:标准库 相关模块:uu, binhex, uu, quopri Base64

    2024年02月05日
    浏览(45)
  • 快速教你如何使用postman工具进行接口测试?(配置全局token、JWT可用)

    现在很多人都在使用前后端分离进行项目开发,那在后端开发过程中使用postman测试工具可快速便捷完成接口测试。但是在测试过程中,很多人发现因为JWT的鉴权,导致半个小时就需要更新一下token,让我们的测试变得复杂。 若是将token作为全局变量,每次都能够自动获取tok

    2024年02月15日
    浏览(49)
  • 前端实现base64编码处理

    文件上传时,因为base64文件字符串过长后端接收失败的问题。 提示:以下是本篇文章正文内容,下面案例可供参考 Base64是一种用于将二进制数据转换为ASCII字符集中可打印字符的编码方法。它通常用于在不同系统之间传输二进制数据,因为许多系统只支持文本数据的传输。 代

    2024年02月12日
    浏览(35)
  • Base64编码的全面介绍

    1. Base64的定义和作用 Base64是一种用64个字符表示二进制数据的编码方式,通常用于在网络传输中将二进制数据转换为可打印字符的形式。Base64编码后的数据由大小写字母、数字和特殊字符组成,可以安全地在文本协议中传输,同时保留数据的完整性。 Base64编码解码 | 一个覆盖

    2024年04月08日
    浏览(39)
  • springboot全局异常处理和自定义异常处理

    在spring项目中,优雅处理异常,好处是可以将系统产生的全部异常统一捕获处理,自定义的异常也由全局异常来捕获,如果涉及到validator参数校验器使用全局异常捕获也是较为方便。 GlobalExceptionHandler类: 自定义异常CustomException类: 通用返回类:AjaxResult 枚举类ResultCodeEnum:

    2024年02月04日
    浏览(43)
  • drf——jwt

    2024年02月06日
    浏览(41)
  • DRF JWT认证进阶

    (1)模型准备 模型准备(继承 django 的 auth_user 表) 添加配置文件,修改用户模型表为自定义表 (2)知识点绑定方法 详情请见:Python 面向对象之绑定和非绑定方法_python 绑定方法-CSDN博客 实例方法 当 对象调用 实例方法时( 对象.实例方法() ), 自动将对象当作第一个参数传

    2024年04月27日
    浏览(25)
  • 登录页面jwt密钥,过滤器,拦截器,异常处理

    需求: 用户未登录时,访问其他也没面,操作添加、删除等操作时,强行跳转至登录页面。 实现方法: 1.使用Cookie,登录后后端添加一个cookie,每次页面判断是否有cookie, 2。使用session,原理同上,只不过session是存储在服务器里的,cookie是在浏览器里。 3。使用jwt令牌,登

    2023年04月25日
    浏览(53)
  • vue:处理base64格式文件pdf、图片预览

    解释一下这段代码的功能: ) preview(item) 是一个函数,接受一个参数 item ,其中包含了文件的相关信息。 )首先,通过条件语句 if (item.type == \\\'pdf\\\') 检查文件类型是否为 \\\'pdf\\\'。 )如果文件类型是 \\\'pdf\\\',则执行以下操作: 使用 webAPI.server.get() 方法发送一个请求,请求的URL是通

    2024年01月18日
    浏览(96)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包