Django rest framework 自定义Exception

时间:2022-11-23 20:25:09

  使用Dango rest framework时,有时需要raise APIException到前端,为了统一错误返回格式,我们需要对exception的格式进行调整。

方法:

1. 在project/utils目录下新建exceptions.py

内容:  

 from rest_framework.views import exception_handler

 def custom_exception_handler(exc,context):
response = exception_handler(exc,context) #获取本来应该返回的exception的response
if response is not None:
#response.data['status_code'] = response.status_code #可添加status_code
response.data['message'] = response.data['detail'] #增加message这个key
del response.data['detail'] #删掉原来的detail
return response

2. 在project/project/settings.py中,增加如下高亮设置:

 REST_FRAMEWORK = {
# Use Django's standard `django.contrib.auth` permissions,
# or allow read-only access for unauthenticated users.
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly',
],
'DEFAULT_THROTTLE_CLASSES': (
'rest_framework.throttling.AnonRateThrottle',
),
'DEFAULT_THROTTLE_RATES': {
'anon': '2/second',
},
'EXCEPTION_HANDLER': 'utils.exceptions.custom_exception_handler' }

3. 在app/views.py中,正常使用raise APIException('lalalalal')即可。