Django REST framework+Vue 打造生鲜电商项目（笔记六）

九、个人中心功能开发
1、drf的api文档自动生成
（1） url

#drf文档，title自定义
path('docs',include_docs_urls(title='火影忍者')),

访问：http://127.0.0.1:8000/docs 就可以自动生成

（2）drf文档的优点：

自动生成
文档里可以做交互和测试
可以生成js，shell和python代码段

（3）代码中注释的格式：

ViewSet的格式，更多请看官方文档

class GoodsListViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin,viewsets.GenericViewSet):
    '''
    list:
        商品列表，分页，搜索，过滤，排序
    retrieve:
        获取商品详情
    '''

（4）Description

添加字段的描述有三种方式：（help_text等）

model的字段中加
serializer的字段加
filter中也可以加

2、动态设置serializer和permission获取用户信息
用户个人信息修改，因为手机号是验证过的，不能随便改

在会员中心页面，想要获取个人信息，只需在UserViewset中多继承一个类：mixins.RetrieveModelMixin。还要重写get_object（“get_object“是用来控制RetrieveModelMixin），返回登录的用户。这样用户只需在users后面加任意id就行，例users/xxx，都会返回当前用户。

因为当我们使用RetrieveModelMixin 的时候，会自动帮我们注册个url（前提是我们在url.py里已经用router注册了users），格式是“users/id”。

另一种方法是可以在re_dict[]里面添加id给返回回去。

（1）用户详情的序列化

这里我们要重新写个serializers来显示用户的详细信息

users/serializers.py

class UserDetailSerializer(serializers.ModelSerializer):
    """
    用户详情
    """
    class Meta:
        model = User
        fields = ("name", "gender", "birthday", "email","mobile")

然后在获取用户详情的时候，我们需要用户是登陆状态的，这就要用到"permission_classes = (permissions.IsAuthenticated, )"，但是这里有个问题，就是在进入用户详情页需要用户登录，但在用户注册的时候就不需要（“class UserViewset”既有用户注册功能，也有查看详情页等功能），所以就需要有一种动态的方式，在用户注册时不进行身份验证，在进入详情页的时候进行身份验证。

查看关于permission的源码之后，

我们就可以把"permission_classes = (permissions.IsAuthenticated, )"改为下面这种

def get_permissions(self):
        if self.action == "retrieve":
            return [permissions.IsAuthenticated()]
        elif self.action == "create":
            return []

        return []

还有一个，修改完上面的内容后，我们在查看详情页时发现只返回"username"和“mobile”两个字段，这是因为我们设置了“serializer_class = UserRegSerializer“，但这个是我们注册的时候用的，在返回详情页的时候我们希望可以获得更多的数据，就是我们前面“UserDetailSerializer“中的内容，所以，遵循一样的思路。

在“serializer_class = UserRegSerializer“后面加上这个，

def get_serializer_class(self):
        if self.action == "retrieve":
            return UserDetailSerializer
        elif self.action == "create":
            return UserRegSerializer

        return UserDetailSerializer

具体过程如下

（2）users/views.py

class UserViewset(CreateModelMixin,mixins.RetrieveModelMixin,viewsets.GenericViewSet):
    '''
    用户
    '''
    serializer_class = UserRegSerializer
    queryset = User.objects.all()
    authentication_classes = (JSONWebTokenAuthentication, authentication.SessionAuthentication)

    def create(self, request, *args, **kwargs):
        serializer = self.get_serializer(data=request.data)
        serializer.is_valid(raise_exception=True)
        user = self.perform_create(serializer)
        re_dict = serializer.data
        payload = jwt_payload_handler(user)
        re_dict["token"] = jwt_encode_handler(payload)
        re_dict["name"] = user.name if user.name else user.username

        headers = self.get_success_headers(serializer.data)

        return Response(re_dict, status=status.HTTP_201_CREATED, headers=headers)

    #这里需要动态权限配置
    #1.用户注册的时候不应该有权限限制
    #2.当想获取用户详情信息的时候，必须登录才行
    def get_permissions(self):
        if self.action == "retrieve":
            return [permissions.IsAuthenticated()]
        elif self.action == "create":
            return []

        return []

    #这里需要动态选择用哪个序列化方式
    #1.UserRegSerializer（用户注册），只返回username和mobile，会员中心页面需要显示更多字段，所以要创建一个UserDetailSerializer
    #2.问题又来了，如果注册的使用userdetailSerializer，又会导致验证失败，所以需要动态的使用serializer
    def get_serializer_class(self):
        if self.action == "retrieve":
            return UserDetailSerializer
        elif self.action == "create":
            return UserRegSerializer

        return UserDetailSerializer

    #虽然继承了Retrieve可以获取用户详情，但是并不知道用户的id，所有要重写get_object方法
    #重写get_object方法，就知道是哪个用户了
    def get_object(self):
        return self.request.user

    def perform_create(self, serializer):
        return serializer.save()

主要添加的内容：

继承mixins.RetrieveModelMixin -->>获取用户信息
重写get_object -->>获取登录的用户
get_permissions -->>动态权限分配
get_serializer_class -->>动态序列化分

用户个人信息修改

只需要多添加一个继承mixins.UpdateModelMixin就可以了

class UserViewset(CreateModelMixin,mixins.RetrieveModelMixin,mixins.UpdateModelMixin,viewsets.GenericViewSet):

Django REST framework+Vue 打造生鲜电商项目（笔记六）

猜你喜欢