mirror of
https://github.com/xhongc/music-tag-web.git
synced 2026-04-25 03:00:54 +08:00
80 lines
2.5 KiB
Python
80 lines
2.5 KiB
Python
# -*- coding: utf-8 -*-
|
||
from django.conf import settings
|
||
from rest_framework import status
|
||
from rest_framework.response import Response
|
||
|
||
from component.drf.constants import ResponseCodeStatus
|
||
|
||
|
||
class ApiGenericMixin(object):
|
||
"""API视图类通用函数"""
|
||
|
||
# TODO 权限部分加载基类中
|
||
if settings.SITE_LOGIN == "false":
|
||
permission_classes = ()
|
||
|
||
def finalize_response(self, request, response, *args, **kwargs):
|
||
"""统一返回数据格式"""
|
||
|
||
if response.status_code == 403:
|
||
pass
|
||
if response.data is None:
|
||
response.data = {
|
||
'result': True,
|
||
'message': 'success',
|
||
'data': None
|
||
}
|
||
elif isinstance(response.data, (list, tuple)):
|
||
response.data = {
|
||
'result': True,
|
||
'message': 'success',
|
||
'data': response.data
|
||
}
|
||
elif isinstance(response.data, dict) and ('code' not in response.data and 'result' not in response.data):
|
||
response.data = {
|
||
'result': True,
|
||
'message': 'success',
|
||
'data': response.data
|
||
}
|
||
if response.status_code == status.HTTP_204_NO_CONTENT and request.method == 'DELETE':
|
||
response.status_code = status.HTTP_200_OK
|
||
|
||
return super(ApiGenericMixin, self).finalize_response(
|
||
request, response, *args, **kwargs
|
||
)
|
||
|
||
|
||
class ApiGatewayMixin(object):
|
||
"""对外开放API返回格式统一
|
||
错误码返回规范为数字：
|
||
正确：0
|
||
错误：39XXXXX
|
||
"""
|
||
|
||
permission_classes = ()
|
||
|
||
def finalize_response(self, request, response, *args, **kwargs):
|
||
"""统一数据返回格式"""
|
||
|
||
if not isinstance(response, Response):
|
||
return response
|
||
|
||
if response.data is None:
|
||
response.data = {"result": True, "code": 0, "message": "success", "data": []}
|
||
elif isinstance(response.data, (list, tuple)):
|
||
response.data = {
|
||
"result": True,
|
||
"code": 0,
|
||
"message": "success",
|
||
"data": response.data,
|
||
}
|
||
elif isinstance(response.data, dict) and not ("code" in response.data and "result" in response.data):
|
||
response.data = {
|
||
"result": True,
|
||
"code": 0,
|
||
"message": "success",
|
||
"data": response.data,
|
||
}
|
||
|
||
return super(ApiGatewayMixin, self).finalize_response(request, response, *args, **kwargs)
|