django drf 统一Response格式

场景

需要将响应体按照格式规范返回给前端。

例如:

响应体中包含以下字段:

python 复制代码
{
    "result": true,
    "data": {},
    "code": 200,
    "message": "ok",
    "request_id": "20cadfe4-51cd-42f6-af81-016639232a66"
}

具体代码

工具类:

python 复制代码
import logging

from rest_framework import status
from rest_framework.response import Response

from django_middleware_global_request import get_request

logger = logging.getLogger("app")


class ResponseMixin:
   def finalize_response(self, request, response, *args, **kwargs):
       """
       异常处理函数,搭配custom_exception_handler进行处理
       :param request:
       :param response:
       :param args:
       :param kwargs:
       :return:
       """
       global_request = get_request()
       current_reqeust_id = getattr(global_request, "current_request_id", None)
       if not getattr(request, "_wrapper_response", True):
           if isinstance(response, Response) and isinstance(response.data, dict):
               response.data["request_id"] = current_reqeust_id
           return super().finalize_response(request, response, *args, **kwargs)
       if isinstance(response, Response):
           if not response.exception:
               response.data = {
                   "result": True,
                   "data": response.data,
                   "code": 200,
                   "message": "ok",
                   "request_id": current_reqeust_id,
               }
           else:
               response.data = {
                   "result": False,
                   "data": response.data,
                   "code": response.status_code,
                   "message": str(response.data),
                   "error": str(response.data),
                   "request_id": current_reqeust_id,
               }
           response.status_code = status.HTTP_200_OK
           response.is_log_resp = True
       return super().finalize_response(request, response, *args, **kwargs)

视图类中使用:

python 复制代码
from common.drf.mixins import ResponseMixin
from rest_framework.viewsets import GenericViewSet, ModelViewSet

class TestViewSet(ResponseMixin,  # 继承工具类
                  ModelViewSet):  # 必须继承viewset, GenericViewSet和ModelViewSet都可
   queryset = models.TestModel.objects.all()
   serializer_class = serializers.TestSerializer

注意:

视图类必须继承viewset,无论是GenericViewSet和ModelViewSet都可以

相关推荐
wuyk5557 小时前
Python办公自动化-第01讲-环境搭建与自动化认知
python·自动化·pyqt
高洁017 小时前
数字孪生与计算机视觉:让机器看懂现场
人工智能·python·机器学习·transformer·迁移学习
ComPDFKit8 小时前
RAG 回答只显示 PDF 文件名?用 Python 保留引用页码
开发语言·python·pdf·rag
yz_aiks9 小时前
Termux 使用教程:把安卓手机变成随身 Linux(装 Python、SSH 远程、跑自动化脚本)
android·linux·python·智能手机·ssh·termux
2601_9679801111 小时前
Flask Web 应用
python·flask·web开发·环境变量·虚拟环境
aifannihao11 小时前
ß 大写变 SS:用 Python 算清 Ruby2Shell 的缓冲区账本
python·安全·标准库·缓冲区溢出·字符串编码
liwulin050612 小时前
【OLLAMA】调用SKILL的通用ReAct
python
郝学胜-神的一滴12 小时前
Effective Python 条款36:优雅拼装迭代器与生成器
开发语言·数据结构·人工智能·python·numpy·scikit-learn
Norna14 小时前
Git 给路径加了引号,这个文件就从 review 里消失了
python
wuyk55514 小时前
Python办公自动化-第04讲-批量新建Excel
开发语言·python·excel