如何使用 django rest swagger 在删除操作中显示序列化程序

问题描述

默认情况下，django rest swagger 不会在 DELETE 方法中显示序列化程序。但是，出于某种原因，我需要实现防止删除和强制删除的情况。

所以，基本上要实现它，我们需要在请求正文中添加例如这个例子：

{
  "forceDelete": true
}

我正在尝试更新 get_serializer_class 函数内的序列化程序，但它仍然无法正常工作。

class ForceDeleteSerializer(serializers.Serializer):
    force_delete = serializers.BooleanField(default=False)


class GroupViewSet(ModelViewSet):
    permission_classes = (IsOrganizationAdmin,)
    serializer_class = GroupSerializer
    search_fields = ('display_name',)

    def get_serializer_class(self):
        if self.action == 'destroy':
            return ForceDeleteSerializer
        return self.serializer_class

解决方法

最后，按照@LinhNguyen 的建议使用 drf-yasg，使用 swagger_auto_schema 就可以了。

from drf_yasg.utils import swagger_auto_schema

@swagger_auto_schema(request_body=ForceDeleteSerializer)
def destroy(self,request,*args,**kwargs):
    ....