DEV Community

Cover image for Flutter File Uploads Made Easy: Working with Multipart APIs
Codexlancers
Codexlancers

Posted on

Flutter File Uploads Made Easy: Working with Multipart APIs

File uploads are one of the most common requirements in real-world Flutter applications-whether it's uploading profile images, documents, or media files.

At our company, we've implemented file upload systems across multiple production apps, and one thing is clear:

Most developers don't struggle with the concept-they struggle with clean implementation.

In this article, we'll break down Multipart file uploads in Flutter using the latest stable packages in a simple, production-ready way.

Why Multipart Requests Matter

When sending data to APIs:

  • JSON works for text data
  • Files (images, PDFs, videos) require multipart/form-data

This format allows sending:

  • Normal fields (userId, email, etc.)
  • Files (binary data)

in a single request.

Real-World Use Cases

We've used multipart uploads in:

  • Profile image uploads
  • KYC verification documents
  • E-commerce product images
  • Chat attachments
  • Resume uploads

Dependencies (Latest Versions)

dependencies:
  http: ^1.6.0
  image_picker: ^1.2.1
  path: ^1.9.1
Enter fullscreen mode Exit fullscreen mode

Step 1: Picking an Image

With the latest image_picker, the API remains stable while ensuring null safety + proper typing.

import 'package:image_picker/image_picker.dart';

final ImagePicker _picker = ImagePicker();

Future<XFile?> pickImage() async {
  try {
    final XFile? image = await _picker.pickImage(
      source: ImageSource.gallery,
      imageQuality: 80,
    );

    return image;
  } catch (e) {
    print("Error picking image: $e");
    return null;
  }
}
Enter fullscreen mode Exit fullscreen mode

Step 2: Multipart Upload Using http

The http ^1.6.0 package still uses MultipartRequest, but we'll structure it more cleanly and safely.

import 'dart:io';
import 'package:http/http.dart' as http;
import 'package:path/path.dart' as path;

Future<void> uploadFile(XFile file) async {
  try {
    var uri = Uri.parse("https://yourapi.com/upload");

    var request = http.MultipartRequest("POST", uri);

    // Optional fields
    request.fields['userId'] = "12345";

    // File name handling
    String fileName = path.basename(file.path);

    // Attach file
    request.files.add(
      await http.MultipartFile.fromPath(
        'file',
        file.path,
        filename: fileName,
      ),
    );

    // Send request
    var streamedResponse = await request.send();

    // Convert response stream
    var response = await http.Response.fromStream(streamedResponse);

    if (response.statusCode == 200) {
      print("Upload successful");
      print("Response: ${response.body}");
    } else {
      print("Upload failed: ${response.statusCode}");
      print("Response: ${response.body}");
    }
  } catch (e) {
    print("Upload error: $e");
  }
}
Enter fullscreen mode Exit fullscreen mode

Step 3: UI Integration

ElevatedButton(
  onPressed: () async {
    final file = await pickImage();

    if (file != null) {
      await uploadFile(file);
    }
  },
  child: const Text("Upload File"),
)
Enter fullscreen mode Exit fullscreen mode

Important Validation (Production Ready)

Always validate file size before uploading:

if (file.lengthSync() > 10 * 1024 * 1024) {
  print("File too large (Max 10MB allowed)");
  return;
}
Enter fullscreen mode Exit fullscreen mode

What Changed in the Latest Approach?

With updated packages, best-practice improvements include:

✔ Proper Response Conversion

http.Response.fromStream(streamedResponse)
Enter fullscreen mode Exit fullscreen mode

✔ Safe Filename Extraction

path.basename(file.path)
Enter fullscreen mode Exit fullscreen mode

Common Mistakes Developers Still Make

1. Not Converting Streamed Responses

Multipart responses come as streams. Ignoring this often results in unreadable output.

2. Missing Filename in Upload Requests

Some servers reject files without explicit filenames.

3. No Error Handling Around Image Picker

Image selection can fail or be cancelled by the user.

4. Uploading Oversized Files

Always validate file size before sending requests.

Best Practices We Follow

At scale, we always ensure:

  • Validate files before upload
  • Use proper filename handling
  • Convert response streams properly
  • Handle cancelled selections gracefully
  • Keep upload logic separated from UI
  • Use HTTPS only

Final Thoughts

File uploads in Flutter aren't complicated—but implementing them correctly makes a huge difference in production applications.

Once you understand how multipart requests work, the workflow becomes straightforward:

  1. Pick a file
  2. Attach it to a request
  3. Send it securely to the server

With Flutter's latest stable packages like http, image_picker, and path, it's possible to build a clean and reliable upload system without unnecessary complexity.

At our company, this exact approach is used across multiple production apps where performance, maintainability, and reliability are critical.

Top comments (0)