Downloading Files from an API with Swift

Welcome back! Today's focus will be on downloading files from an API using Swift. Understanding how to retrieve files efficiently not only enhances your technical skills but also broadens your application's capabilities. In this lesson, we'll explore a practical scenario using our To-Do list API, which, in addition to managing tasks, supports handling text files such as notes. These notes can be downloaded or uploaded through the /notes endpoint, allowing functionality for storing supplementary information. For example, users might keep notes about a meeting or important reminders. By understanding how to interact with this endpoint, you can effectively manage notes within your application. By the end of this lesson, you'll know how to request a file from an API, save it locally, and verify its contents.

Let's dive into downloading files with precision and confidence!

GET requests are fundamental for retrieving files from an API. When you send a GET request using URLSession, your client communicates with the server at a specified URL, asking it to provide the file. The server responds with the file data, if available and permissible, along with an HTTP status code (like 200 OK).

Here's a basic example of downloading a file named welcome.txt from our API at http://localhost:8000/notes. This approach downloads the entire file at once, which is manageable for smaller files.

import Foundation
import FoundationNetworking

// Base URL for the API
let baseURL = "http://localhost:8000"

// Specify the note name to download
let noteName = "welcome.txt"

// Create a DispatchGroup
let dispatchGroup = DispatchGroup()

// Create the URL for the request
if let url = URL(string: "\(baseURL)/notes/\(noteName)") {
    dispatchGroup.enter() // Enter the group
    let task = URLSession.shared.dataTask(with: url) { data, response, error in
        if let error = error {
            print("Error occurred: \(error)")
            dispatchGroup.leave() // Leave the group
            return
        }
        
        if let httpResponse = response as? HTTPURLResponse, httpResponse.statusCode == 200 {
            if let data = data {
                // Save the file locally
                let fileURL = FileManager.default.temporaryDirectory.appendingPathComponent("downloaded_\(noteName)")
                do {
                    try data.write(to: fileURL)
                    print("File downloaded successfully to \(fileURL.path)")
                } catch {
                    print("File error occurred: \(error)")
                }
            }
        } else {
            print("Failed to download file. HTTP Status Code: \((response as? HTTPURLResponse)?.statusCode ?? 0)")
        }
        dispatchGroup.leave() // Leave the group
    }
    task.resume()
}

// Wait for the download to complete
dispatchGroup.wait()
print("Download task completed.")

In this code example, we use a GET request to download a file in its entirety. Here's a breakdown of the key components:

• URLSession.dataTask: This method is used to perform a data task, which retrieves the entire file data at once. It's suitable for smaller files.
• DispatchGroup: This is used to manage the asynchronous nature of the task, ensuring that the program waits for the download to complete before proceeding.
• Error Handling: The code checks for errors in the response and handles them appropriately.
• File Writing: Once the data is received, it's written to a local file using data.write(to:).

This method works well for small files but can strain memory for larger files.