如何从 drf-spectaulous API 文档中删除 RetrieveUpdateAPIView 中的 put 方法?

Sam*_*ane 2 api django documentation django-rest-framework drf-yasg

我有以下观点:

class PersonalInfos(generics.RetrieveUpdateAPIView):
    serializer_class = ClientSerializer
    permission_classes = [IsAuthenticated]
    def get_queryset(self):
        """
        :return: A QuerySet Object
        """
        return Client.objects.get(user=self.request.user)

    def get(self, *args):
        """
        :param args: Handled by rest_framework views.dispatch

        :return: JSON object containing User Personal Data
        """
        queryset = self.get_queryset()
        serializer = ClientSerializer(queryset)
        return Response(data=serializer.data)

    def patch(self, request):
        """
        :param request: request object is sent by the client

        :return:  Json response with the data sent of the body
        """

        client = self.get_queryset()
        serializer = ClientSerializer(client, data=request.data, partial=True)
        if serializer.is_valid():
            serializer.save()
            return Response(data=serializer.data, status=200)
        return Response(data="Unexpected Parameters", status=400)
Run Code Online (Sandbox Code Playgroud)

视图中一切正常,但问题是我正在使用 drf-spectaulous,它在文档中向我展示了 API 中不需要的 PUT 方法。我的问题是,如何自定义 drf-spectaulous 以不在文档中包含 PUT 方法?

在此输入图像描述

小智 9

您可以使用@extend_schema装饰器从生成的模式中排除一种或多种方法,如下所示。

@extend_schema(methods=['PUT'], exclude=True)
Run Code Online (Sandbox Code Playgroud)