1. 程式人生 > >Django REST framework+Vue 打造生鮮電商專案(筆記六)

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):