在實際項目開發中,原有框架的response可能并不能完全滿足我們的需求。比如我們需要定義一些更加詳細的RESULT_CODE來說明情況。那么我們就可以基于原有的response進行自定義。
下面是一個自定義Django rest_framework中response的示例
# -*- coding:utf-8 -*-
import json
from rest_framework.response import Response
from rest_framework.status import HTTP_403_FORBIDDEN, HTTP_404_NOT_FOUND, HTTP_401_UNAUTHORIZED, \HTTP_402_PAYMENT_REQUIRED, HTTP_400_BAD_REQUEST, HTTP_500_INTERNAL_SERVER_ERROR, HTTP_200_OK
from rest_framework.pagination import PageNumberPaginationRESPONSE_STATUS = [200, 400, 401, 403, 404, 500]
RESULT_CODE_DICT = {200: {'0': '成功',},400: {'10000': '請求參數無效','10001': '資源存在,無需重復創建','10002': '參數缺失',},401: {'10100': '用戶需要登錄:Token無效或缺失','10101': '用戶凍結','10102': 'Token無效','10103': 'Token缺失','10104': 'Authentication Key無效','10105': 'Token過期'},403: {'10300': '沒有權限訪問','10301': '權限密鑰無效',},404: {'10400': '所請求的資源不存在'},500: {'10500': '系統錯誤'}
}# 基于rest_framework的Response
def api_success(data=None, message='', headers=None):if not message:message = '成功'return Response({'result': True, 'result_code': '0', 'result_text': str(message), "message": str(message), 'data': data},status=HTTP_200_OK, headers=headers)def api_bad_request(message=''):if not message:message = '請求參數有誤'return Response({'result': False, 'result_code': '10000', 'result_text': str(message), "message": str(message)},status=HTTP_400_BAD_REQUEST)def api_request_params_required(params):if not params:message = '檢查請求參數是否完整'else:if isinstance(params, str):params = (params,)message = '參數:{}為必填'.format(','.join(params))return Response({'result': False, 'result_code': '10002', 'result_text': str(message), "message": str(message)},status=HTTP_400_BAD_REQUEST)def api_repeated_request(message=''):if not message:message = '資源存在,無需重復創建'return Response({'result': False, 'result_code': '10001', 'result_text': str(message), "message": str(message)},status=HTTP_400_BAD_REQUEST)def api_unauthorized(message=''):if not message:message = '用戶登錄驗證失敗'return Response({'result': False, 'result_code': '10100', 'result_text': str(message), "message": str(message)},status=HTTP_401_UNAUTHORIZED)def api_invalid_authentication_key(message=''):if not message:message = 'Authentication Key無效'return Response({'result': False, 'result_code': '10104', 'result_text': str(message), "message": str(message)},status=HTTP_401_UNAUTHORIZED)def api_authentication_expired(message=''):if not message:message = 'Token過期'return Response({'result': False, 'result_code': '10105', 'result_text': str(message), "message": str(message)},status=HTTP_401_UNAUTHORIZED)def api_suspended(message=''):if not message:message = '用戶凍結'return Response({'result': False, 'result_code': '10101', 'result_text': str(message), "message": str(message)},status=HTTP_401_UNAUTHORIZED)def api_permissions_required(permissions=None):if not permissions:message = '沒有權限訪問'else:if isinstance(permissions, str):permissions = (permissions,)message = '缺失權限:{}'.format(','.join(permissions))return Response({'result': False, 'result_code': '10300', 'result_text': str(message), "message": str(message)},status=HTTP_403_FORBIDDEN)def api_invalid_permission_key(message=''):if not message:message = '權限驗證失敗'return Response({'result': False, 'result_code': '10301', 'result_text': str(message), "message": str(message)},status=HTTP_403_FORBIDDEN)def api_not_found(message=''):if not message:message = '所請求的資源不存在'return Response({'result': False, 'result_code': '10400', 'result_text': str(message), "message": str(message)},status=HTTP_404_NOT_FOUND)def api_error(message=''):if not message:message = '系統錯誤'return Response({'result': False, 'result_code': '10500', 'result_text': str(message), "message": str(message)},status=HTTP_500_INTERNAL_SERVER_ERROR)def build_pagination_response(request, queryset, serializer_class):data, headers = build_pagination_queryset_data(request, queryset, serializer_class)return api_success(data=data, headers=headers)def build_pagination_queryset_data(request, queryset, serializer_class):"""為分頁接口返回的headers中自定義一些信息:param request::param queryset::param serializer_class::return:"""page = request.GET.get('page', None)page_size = request.GET.get('page_size', None)total = len(queryset)headers = Noneif page and page_size:paginator = PageNumberPagination()paginator.page_size_query_param = 'page_size'queryset = paginator.paginate_queryset(queryset, request)pagination_params = json.dumps({'total': total, 'page': int(page), 'page_size': int(page_size)})headers = {'X-Pagination': pagination_params,'Access-Control-Expose-Headers': 'X-Pagination'}data = serializer_class(queryset, many=True).datareturn data, headers