Can I return a different Django Response based on whether or not the view is invoked from swagger?

Question

I am using Django-Rest-Framework for my API. And I am documenting that API w/ swagger using drf_yasg. One of my views returns a Django FileResponse.

When I access the view directly at "http://localhost:8000/api/my_documents/1" it successfully displays the (PDF) file. But when I access it via swagger it successfully returns a 200 but gives the following message:

Unrecognized response type; displaying content as text.

This is b/c of this issue in swagger itself. As suggested in that ticket, the problem goes away if I change the "Content-Disposition" response header from "inline" to "attachment". However, I don't want to always download the file.

My question is: Can I determine whether the request was made by swagger in the view and conditionally change the headers? Something like:

class MyDocumentView(GenericAPIVIew):

  def get(self, request, pk):
    my_document = MyDocument.objects.get(pk=pk)
    response = FileResponse(my_document.file)  # (file is a FileField)

    # WHAT DO I PUT HERE ?!?
    if request.is_from_swagger:
      response.headers["Content-Disposition"] = response.headers["Content-Disposition"].replace("inline", "attachment")

    return response

Thanks.

Toni Sredanović · Accepted Answer · 2021-04-26T17:08:41.157

1

You can do this by checking the request.headers.get('referer'). There should be your swagger url in there.

edited Apr 26 '21 at 17:08

answered Apr 26 '21 at 16:37

Toni Sredanović

2,280
1
11
13

1

That's an excellent idea. But I'm using `drf_yasg`. My `request.accepted_renderer` is an instance of `rest_framework.renderers.JSONRenderer`. – trubliphone Apr 26 '21 at 16:43
Maybe try checking the `request.headers.get('referer')`? There should be your `swagger` url in there, let me know how that goes. – Toni Sredanović Apr 26 '21 at 17:04
1

That works fine. Thanks very much. If you adjust your answer, I'll accept it. – trubliphone Apr 26 '21 at 17:05

Can I return a different Django Response based on whether or not the view is invoked from swagger?

1 Answers1