修改 Django Rest framework ModelViewSet 的默认返回信息

栏目: Python · 发布时间: 5年前

内容简介:drf API 接口默认返回的只是数据的JSON字符串,不包含其它的接口信息,甚至有时候格式也不一致,这对前端不太友好,所以我希望把这个返回修改一下,往返回信息里面添加一些额外的信息,如首先,要知道在哪里修改这个返回,翻一下源码发现这些返回信息是写在知道在哪里改后,接着就是改这些方法的返回信息了,我希望给前端返回这样格式的信息:

drf API 接口默认返回的只是数据的JSON字符串,不包含其它的接口信息,甚至有时候格式也不一致,这对前端不太友好,所以我希望把这个返回修改一下,往返回信息里面添加一些额外的信息,如 状态说明 等信息

首先,要知道在哪里修改这个返回,翻一下源码发现这些返回信息是写在 create()list()retrieve()update() destroy() 这些方法里的,这些信息都放在 Response 对象里面返回到前端页面去。

修改 Django Rest framework ModelViewSet 的默认返回信息
修改 Django Rest framework ModelViewSet 的默认返回信息
修改 Django Rest framework ModelViewSet 的默认返回信息
修改 Django Rest framework ModelViewSet 的默认返回信息
修改 Django Rest framework ModelViewSet 的默认返回信息

知道在哪里改后,接着就是改这些方法的返回信息了,我希望给前端返回这样格式的信息:

{'code': 1, 'msg': '成功', 'errors': {}, 'data': []} # errors 放具体的错误信息,data 放返回去的数据

然后用这个 dict 直接替换 Response 里面的信息就行了,如下:

修改 Django Rest framework ModelViewSet 的默认返回信息

替换后,尝试请求下接口,默认的返回格式就变成我们定义的样子了,但是,任务还没完成,在只有一个接口的情况下,这样改改没什么,但是如果有十几个,几十个接口的话,这样一个个接口去改,不但累人还不好维护,所以这里换种方法。

我们通过定义一个继承于 ModelViewSet 的类,然后所有的接口不再继承 ModelViewSet 而继承于这个 CustomViewSet ,这就不用一个个接口去改了,还方便维护。

修改 Django Rest framework ModelViewSet 的默认返回信息

到此为止,任务依然没有完成,成功的返回我们是定义好了,但是接口发生异常的时候,返回的信息还是默认的那些信息,因为我们改的只是正常处理完成后的成功返回,异常返回我们是没有处理,那异常信息的返回应该在哪里改?

一顿调试后,我发现了当接口发生异常后,是由 exception_handler 这个方法去处理的。这个方法定义在 rest_framework/views.py 里,因为这个方法是独立出来的,不是定义在 ModelViewSet 里面,所以就没办法通过重写的方法来改了,我们把整个方法复制出来,放在 CustomViewSet 下面(当然没有规定要放在一起,放在哪里都行,方便管理就行)。

修改 Django Rest framework ModelViewSet 的默认返回信息

可以看出,第95行到98行就是我们需要改的地方,调试看一下这个对象是怎样的,然后进一步把里面我们需要的信息提取出来,改成这个样子:

修改 Django Rest framework ModelViewSet 的默认返回信息

最重要的一步!要在 settings.py 里面的 REST_FRAMEWORK (自己添加的)里添加多一条这样的配置:

REST_FRAMEWORK = {
    ······
    ······
    
    'EXCEPTION_HANDLER': 'common.views.exception_handler'
}
复制代码

这里指定了使用哪个方法作为接口异常的处理器,这个设置成我们刚刚改那个。

PS: 虽然做了上面的修改后,就修改了系统上大部分的返回信息,但是有时候我们需要定一个接口不是继承 ModelViewSet 的,这样这些修改就不能继承到了,在这样的情况下,每写一次接口,都要自己手动敲一遍这些信息,难免会手快敲错了,在这里我定义了一个类:

修改 Django Rest framework ModelViewSet 的默认返回信息

那上面的接口就可以改成这个样子了,更加的方便维护:

修改 Django Rest framework ModelViewSet 的默认返回信息

以上所述就是小编给大家介绍的《修改 Django Rest framework ModelViewSet 的默认返回信息》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持!

查看所有标签

猜你喜欢:

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

软件测试

软件测试

[美]Ron Patton / 张小松、王珏、曹跃 / 机械工业出版社 / 2006-4 / 30.00元

软件测试(原书第2版),ISBN:9787111185260,作者:(美)佩腾(Patton,R.) 著,张小松 等译;张小松译一起来看看 《软件测试》 这本书的介绍吧!

随机密码生成器
随机密码生成器

多种字符组合密码

XML 在线格式化
XML 在线格式化

在线 XML 格式化压缩工具

RGB HSV 转换
RGB HSV 转换

RGB HSV 互转工具