web-dev-qa-db-ja.com

Django REST Frameworkで生成されたファイルのダウンロードを返す方法は?

生成されたファイルのダウンロードをDjango REST Framework Responseとして返します。以下を試しました。

def retrieve(self, request, *args, **kwargs):
    template = webodt.ODFTemplate('test.odt')
    queryset = Pupils.objects.get(id=kwargs['pk'])
    serializer = StudentSerializer(queryset)
    context = dict(serializer.data)
    document = template.render(Context(context))
    doc = converter().convert(document, format='doc')
    res = HttpResponse(
        FileWrapper(doc),
        content_type='application/msword'
    )
    res['Content-Disposition'] = u'attachment; filename="%s_%s.Zip"' % (context[u'surname'], context[u'name'])
    return res

しかし、mswordドキュメントをjsonとして返します。

代わりにファイルとしてダウンロードを開始するにはどうすればよいですか?

15
Viktor

メディアフォルダーにファイルを保存し、そのリンクをフロントエンドに送信することで問題を解決しました。

@permission_classes((permissions.IsAdminUser,))
class StudentDocxViewSet(mixins.RetrieveModelMixin, viewsets.GenericViewSet):
    def retrieve(self, request, *args, **kwargs):
        template = webodt.ODFTemplate('test.odt')
        queryset = Pupils.objects.get(id=kwargs['pk'])
        serializer = StudentSerializer(queryset)
        context = dict(serializer.data)
        document = template.render(Context(context))
        doc = converter().convert(document, format='doc')
        p = u'docs/cards/%s/%s_%s.doc' % (datetime.now().date(), context[u'surname'], context[u'name'])
        path = default_storage.save(p, doc)
        return response.Response(u'/media/' + path)

そしてこれを私のフロントエンド(AngularJS SPA)のように処理しました

$http(req).success(function (url) {
    console.log(url);
    window.location = url;
})
2
Viktor

これはあなたのために働くかもしれません:

file_path = file_url
FilePointer = open(file_path,"r")
response = HttpResponse(FilePointer,content_type='application/msword')
response['Content-Disposition'] = 'attachment; filename=NameOfFile'

return response.

フロントエンドコードについては this を参照してください

6

DRFから直接ファイルのダウンロードを返す例を次に示します。トリックは、カスタムレンダラーを使用して、ビューから直接Responseを返すことができるようにすることです。

from Django.http import FileResponse
from rest_framework import viewsets, renderers
from rest_framework.decorators import action

class PassthroughRenderer(renderers.BaseRenderer):
    """
        Return data as-is. View should supply a Response.
    """
    media_type = ''
    format = ''
    def render(self, data, accepted_media_type=None, renderer_context=None):
        return data

class ExampleViewSet(viewsets.ReadOnlyModelViewSet):
    queryset = Example.objects.all()

    @action(methods=['get'], detail=True, renderer_classes=(PassthroughRenderer,))
    def download(self, *args, **kwargs):
        instance = self.get_object()

        # get an open file handle (I'm just using a file attached to the model for this example):
        file_handle = instance.file.open()

        # send file
        response = FileResponse(file_handle, content_type='whatever')
        response['Content-Length'] = instance.file.size
        response['Content-Disposition'] = 'attachment; filename="%s"' % instance.file.name

        return response

デフォルトのエンドポイントdownloadの代わりにカスタムエンドポイントretrieveを使用していることに注意してください。これにより、ビューセット全体ではなく、このエンドポイントだけのレンダラーを簡単にオーバーライドできます。とにかく通常のJSONを返すためのリストと詳細に意味があります。ファイルのダウンロードを選択的に返す場合は、カスタムレンダラーにロジックを追加できます。

5
Jack Cushman

私は別の同様の質問への回答でプロセス全体を簡略化しました。私の回答を自由に参照してください。これが私の回答へのリンクです: https://stackoverflow.com/a/61075310/9142137

私の回答では、ファイルをjsonとして返すのではなく、APIの応答として画像(ファイル)をダウンロードする方法を示しました

0
Suraj S Jain

DRFを使用していて、ファイルをダウンロードするためのビューコードを見つけました。

from rest_framework import generics
from Django.http import HttpResponse
from wsgiref.util import FileWrapper

class FileDownloadListAPIView(generics.ListAPIView):

    def get(self, request, id, format=None):
        queryset = Example.objects.get(id=id)
        file_handle = queryset.file.path
        document = open(file_handle, 'rb')
        response = HttpResponse(FileWrapper(document), content_type='application/msword')
        response['Content-Disposition'] = 'attachment; filename="%s"' % queryset.file.name
        return response

そしてurl.pyは

path('download/<int:id>/',FileDownloadListAPIView.as_view())

フロントエンドでReact.jsを使用していますが、次のような応答が返されます

handleDownload(id, filename) {
  fetch(`http://127.0.0.1:8000/example/download/${id}/`).then(
    response => {
      response.blob().then(blob => {
      let url = window.URL.createObjectURL(blob);
      let a = document.createElement("a");
      console.log(url);
      a.href = url;
      a.download = filename;
      a.click();
    });
  });
}

正しく開くファイルのダウンロードに成功した後、これが機能することを願っています。ありがとう

0
Muhammad Zohaib