定制返回格式

最新推荐文章于 2025-05-11 08:42:46 发布

youjian42

最新推荐文章于 2025-05-11 08:42:46 发布

阅读量255

点赞数 1

分类专栏： drf学习文章标签： python django

本文链接：https://blog.youkuaiyun.com/youjian42/article/details/138508902

版权

drf学习专栏收录该内容

23 篇文章

订阅专栏

本文介绍了如何在使用第三方库如rest_framework_simplejwt时，由于接口返回格式不符预期，通过重写全局钩子函数或序列化器来定制登录成功的返回数据，包括添加自定义字段和处理token信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

因为登陆的接口不是我们写的，所以返回格式不符合我们的预期，下面就开始详细地展示如何定制返回格式

方法一：重写全局钩子函数

首先编写序列化类，给登陆接口用。

from rest_framework_simplejwt.serializers import TokenObtainPairSerializer

class CommonTokenObtainSerializer(TokenObtainPairSerializer):
    # 重写全局钩子, 用原来的进行校验， 返回字典
    def validate(self, attrs):
        dic = super().validate(attrs)
        data = {
            'code': 100,
            'msg': '登陆成功',
            'username': self.user.username,
            'refresh': dic.get('refresh'),
            'access': dic.get('access')
        }
        return data

然后在设置里面输入下面的，将它变成我们自己写的序列化类

方法二：重写荷载

from rest_framework_simplejwt.serializers import TokenObtainPairSerializer

class CommonTokenObtainSerializer(TokenObtainPairSerializer):

    @classmethod
    def get_token(cls, user):
        # super()代指父类对象
        # 对象调用类的绑定方法，会自动吧对象的类传入
        token = super().get_token(user)
        token['name'] = user.username
        return token

    def validate(self, attrs):
        token = self.get_token(self.user)
        data = {
            'code': 100,
            'msg': '登陆成功',
            'username': self.user.username,
            'refresh': str(token),
            'access': str(token.accrss_token)
        }
        return data