參考 Django rest framework自定義返回數據格式
一、簡介
drf 默認返回的異常格式是這樣的
1 { 2 "username": [ 3 "該字段是必填項。" 4 ], 5 "password": [ 6 "該字段是必填項。" 7 ] 8 }
但是在實際工作中、這樣的數據不利於前端的渲染，一般是這樣的格式返回(有錯誤的時候)
{ "msg": "username該字段是必填項。", "code": 0, "data": "" }
正確的時候
1 { 2 "msg": "success", 3 "code": 1, 4 "data": { 5 "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTU4NjMxMDk5NCwianRpIjoiZTkzZDlhYzZhMWM5NDQ2NTgyN2ZkMzJmNWYzNDVlNjIiLCJ1c2VyX2lkIjoxfQ.Nca8X5AClJxVuDK1-wxJBFZI9WzXt2UL3bytyRckqTU", 6 "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNTg1NjE5Nzk0LCJqdGkiOiI0NjZkMzk2ZThiMjU0MDQxYTE5OWJjZTc5MjRjNDc2ZiIsInVzZXJfaWQiOjF9.9oaLarHvtT8Zo9dV312Y5fE9HtkTp9Uxrx4WWo_8etg", 7 "username": "hahn", 8 "user_id": 1 9 } 10 }
想要弄成這樣的效果需要自定義drf異常返回和自定義數據返回格式
在settings.py中
EXCEPTION_HANDLER對應的是你文件夾路徑
# drf配置 REST_FRAMEWORK = { # 全局配置異常模塊 'EXCEPTION_HANDLER': 'utils.exception.custom_exception_handler', # 修改默認返回JSON的renderer的類 'DEFAULT_RENDERER_CLASSES': ( 'utils.rendererresponse.customrenderer', ), }
二、設置異常返回
這里我是utils文件夾里面新建了exception.py文件
這里可以根據你的需求修改、我這個只是參考，具體解釋看注釋
# 自定義異常處理 from rest_framework.views import exception_handler from rest_framework.views import Response from rest_framework import status # 將僅針對由引發的異常生成的響應調用異常處理程序。它不會用於視圖直接返回的任何響應 #需要在setting中配置這個異常處理方法,並且異常返回的respose對象還會傳到默認返回的json的renderer類中，在setting中drf配置中的DEFAULT_RENDERER_CLASSES # 如果未聲明，會采用默認的方式，如下 # # REST_FRAMEWORK = { # 'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler' # } # 下面是我配置的已經自定義的處理 # REST_FRAMEWORK = { # # 全局配置異常模塊 # 'EXCEPTION_HANDLER': 'utils.exception.custom_exception_handler', # # 修改默認返回JSON的renderer的類 # 'DEFAULT_RENDERER_CLASSES': ( # 'utils.rendererresponse.customrenderer', # ), # } def custom_exception_handler(exc, context): # 先調用REST framework默認的異常處理方法獲得標准錯誤響應對象 response = exception_handler(exc, context) #print(exc) #錯誤原因 還可以做更詳細的原因，通過判斷exc信息類型 #print(context) # 錯誤信息 # print('1234 = %s - %s - %s' % (context['view'], context['request'].method, exc)) #print(response) #如果response響應對象為空，則設置message這個key的值，並將狀態碼設為500 #如果response響應對象不為空，則則設置message這個key的值，並將使用其本身的狀態碼 if response is None: return Response({ 'message': '服務器錯誤:{exc}'.format(exc=exc) }, status=status.HTTP_500_INTERNAL_SERVER_ERROR, exception=True) else: # print('123 = %s - %s - %s' % (context['view'], context['request'].method, exc)) return Response({ 'message': '服務器錯誤:{exc}'.format(exc=exc), }, status=response.status_code, exception=True) return response
三、設置自定義返回數據結構
這里我是在utils文件夾里面新建了rendererresponse.py文件
這里可以根據你的需求修改、我這個只是參考，解釋看注釋
1 ''' 2 自定義返回處理 3 ''' 4 5 # 導入控制返回的JSON格式的類 6 from rest_framework.renderers import JSONRenderer 7 8 9 class customrenderer(JSONRenderer): 10 # 重構render方法 11 def render(self, data, accepted_media_type=None, renderer_context=None): 12 if renderer_context: 13 14 #print(renderer_context) 15 #print(renderer_context["response"].status_code) 16 17 # 響應的信息，成功和錯誤的都是這個 18 #成功和異常響應的信息，異常信息在前面自定義異常處理中已經處理為{'message': 'error'}這種格式 19 #print(data) 20 21 # 如果返回的data為字典 22 if isinstance(data, dict): 23 #響應信息中有message和code這兩個key，則獲取響應信息中的message和code，並且將原本data中的這兩個key刪除，放在自定義響應信息里 24 #響應信息中沒有則將msg內容改為請求成功 code改為請求的狀態碼 25 msg = data.pop('message', '請求成功') 26 code = data.pop('code', renderer_context["response"].status_code) 27 #如果不是字典則將msg內容改為請求成功 code改為請求的狀態碼 28 else: 29 msg = '請求成功' 30 code = renderer_context["response"].status_code 31 32 #自定義返回的格式 33 ret = { 34 'msg': msg, 35 'code': code, 36 'data': data, 37 } 38 # 返回JSON數據 39 return super().render(ret, accepted_media_type, renderer_context) 40 else: 41 return super().render(data, accepted_media_type, renderer_context)
請求正確返回格式
請求錯誤返回格式
