如何使用 drf-yasg 在 django-rest-framework 中为文件上传 API 创建 swagger 模式？

Question

我找不到为文件上传制作架构的任何支持 API。 Swagger UI 必须有一个按钮，允许测试人员上传文件以进行测试。我使用 firebase 作为数据库，因此序列化程序和模型不会出现在图片中。我只使用 Django 的休息框架。

我查看了 drf-yasg 的文档，该文档建议使用 Operation 进行文件上传。但它是一个非常抽象和晦涩的文档。

Answer 1

确保在视图中指定 parser_classes。默认情况下，它是 JSON 不处理文件上传的解析器。使用 MultiPartParser 或 FileUploadParser

class MyUploadView(CreateAPIView):
    parser_classes = (MultiPartParser,)
    ...

    @swagger_auto_schema(operation_description='Upload file...',)
    @action(detail=False, methods=['post'])
    def post(self, request, **kwargs):
        # Code to handle file

Answer 2

看看这个 issue。您可以找到如何使用 @swagger_auto_schema 来创建这样的内容

Answer 3

这是我项目中的工作示例

from rest_framework import parsers, renderers, serializers, status
from rest_framework.generics import GenericAPIView
from rest_framework.response import Response


class ContactSerializer(serializers.Serializer):
    resume = serializers.FileField()


class ContactView(GenericAPIView):
    throttle_classes = ()
    permission_classes = ()
    parser_classes = (parsers.FormParser, parsers.MultiPartParser, parsers.FileUploadParser)
    renderer_classes = (renderers.JSONRenderer,)
    serializer_class = ContactSerializer

    def post(self, request):
        serializer = self.serializer_class(data=request.data)
        if serializer.is_valid(raise_exception=True):
            data = serializer.validated_data
            resume = data["resume"]
            # resume.name - file name
            # resume.read() - file contens
            return Response({"success": "True"})
        return Response({'success': "False"}, status=status.HTTP_400_BAD_REQUEST)

如何使用 drf-yasg 在 django-rest-framework 中为文件上传 API 创建 swagger 模式？

How to make swagger schema for file upload API in django-rest-framework using drf-yasg?

django

swagger

drf-yasg