Writing a file upload API using Django

Question

I have a Django app that revolves around users uploading files, and I'm attempting to make an API. Basically, the idea is that a POST request can be sent (using curl for example) with the file to my app which would accept the data and handle it.

How can I tell Django to listen for and accept files this way? All of Django's file upload docs revolve around handling files uploaded from a form within Django, so I'm unsure of how to get files posted otherwise.

If I can provide any more info, I'd be happy to. Anything to get me started would be much appreciated.

The forms accept a POST request, and would do exactly what you would want to do. — X-Istence
– X-Istence, Commented Jun 11, 2011 at 9:22

KayleMaster · Accepted Answer · 2021-09-09 11:39:17Z

11

Create a small view which accepts only POST and make sure it does not have CSRF protection:
forms.py

from django import forms

class UploadFileForm(forms.Form):
    title = forms.CharField(max_length=50)
    file  = forms.FileField()

views.py

from django.views.decorators.csrf import csrf_exempt
from django.views.decorators.http import require_POST
from django.http import HttpResponse, HttpResponseServerError

# Imaginary function to handle an uploaded file.
from somewhere import handle_uploaded_file

@csrf_exempt
@require_POST
def upload_file(request):            
    form = UploadFileForm(request.POST, request.FILES)
    if not form.is_valid():
        return HttpResponseServerError("Invalid call")
        
    handle_uploaded_file(request.FILES['file'])
    return HttpResponse('OK')

2 Comments

ybdesire Over a year ago

It's more secure if "@csrf_exempt" can be removed. :)

Udi Over a year ago

@ybdesire csrf is designed for forms. A different authentication method should be considered for API calls.

Collectives™ on Stack Overflow

Writing a file upload API using Django

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related