Uploading Files to an API

Welcome to the next phase in mastering API interactions with Scala 3 and Requests-Scala! In our previous lesson, you learned how to download files efficiently using an API, enhancing your skills in file management. Today, we will explore the reverse process: uploading files to an API. This capability is essential for creating applications that need to store or share files, such as documents, images, or any other type of data with an external server. Understanding file uploads will further expand your ability to interact with APIs, equipping you to build more robust and feature-complete applications. By the end of this lesson, you will learn how to send a file to a server using Scala 3, ensuring that you can manage uploads confidently and efficiently.

Understanding HTTP File Uploads

To upload files via HTTP, the POST method is commonly used, as it's designed for submitting data to a server, including files. The key to sending files is using multipart/form-data, a format that allows both text and binary data to be sent together, organized into separate parts. This format ensures the server can properly handle the uploaded file along with any additional data. In Scala, using Requests-Scala, this process is handled seamlessly. When you prepare a file for upload, Requests-Scala automatically manages the multipart/form-data complexity for you, streamlining the process of file uploads to your server. Here's a simple example illustrating how to upload a file using Requests-Scala: import requests.* import scala.util.{Try, Success, Failure} import java.nio.file.{Paths, Files} import java.io.File @main def solution(): Unit = val baseUrl = "http://localhost:8000" val fileName = "file.txt" val filePath = Paths.get(fileName) Try { if !Files.exists(filePath) then throw new java.io.FileNotFoundException(s"File not found: $fileName") val response = requests.post( s"$baseUrl/upload", data = requests.MultiPart( requests.MultiItem("file", new File(fileName), fileName) ) ) if response.statusCode >= 400 then throw new Exception(s"HTTP error occurred: ${response.statusCode}\n${response.text()}") println(s"File uploaded successfully: $fileName") } match case Success(_) => case Failure(e: java.io.FileNotFoundException) => println(e.getMessage) case Failure(e) => println(s"Other error occurred: $e") In this example, the file is sent using requests.MultiPart, which handles the multipart/form-data details for you. The file is uploaded under the field name "file", as required by the API.

Code Example: Uploading a File

Now, let's dive into the process of uploading a file using Scala 3. Consider the following code, which uploads a file named meeting_notes.txt to the "/notes" endpoint. import requests.* import scala.util.{Try, Success, Failure} import java.nio.file.{Paths, Files} import java.io.File @main def solution(): Unit = val baseUrl = "http://localhost:8000" val fileName = "meeting_notes.txt" val filePath = Paths.get(fileName) Try { if !Files.exists(filePath) then throw new java.io.FileNotFoundException(s"File not found: $fileName") val response = requests.post( s"$baseUrl/notes", data = requests.MultiPart( requests.MultiItem("file", new File(fileName), fileName) ) ) if response.statusCode >= 400 then throw new Exception(s"HTTP error occurred: ${response.statusCode}\n${response.text()}") println(s"File uploaded successfully: $fileName") } match case Success(_) => case Failure(e: java.io.FileNotFoundException) => println(e.getMessage) case Failure(e) => println(s"Other error occurred: $e") This Scala code demonstrates how to properly upload a file to an API: We use requests.MultiPart to send the file in a multipart/form-data request, ensuring the file is uploaded correctly. The requests.post() function sends a POST request to the API's /notes endpoint, attaching the file in the request payload. Responses and errors are handled using Scala's Try, Success, and Failure constructs to manage potential issues gracefully.

Verifying the File Upload

Once a file is uploaded, it's important to verify it to ensure that the file is stored correctly on the server. You can achieve this by sending a GET request to the corresponding endpoint and checking the content of the uploaded file. def verifyUpload(): Unit = val baseUrl = "http://localhost:8000" val fileName = "meeting_notes.txt" Try(requests.get(s"$baseUrl/notes/$fileName")) match case Success(response) if response.statusCode == 200 => println(response.text()) case Success(response) => println(s"Failed to retrieve file with status code: ${response.statusCode}") case Failure(exception) => println(s"An error occurred: ${exception.getMessage}") In this code, we retrieve the content of the file from the server and print it out, allowing us to confirm that the file has been uploaded and stored successfully. Sample output for successful verification might appear as: Meeting Notes Date: 2023-10-18 Time: 3:00 PM Location: Conference Room A Attendees: - Alice Johnson - Bob Smith - Charlie Brown ... This output confirms that the file meeting_notes.txt is present on the server and its contents are intact, with details such as the date, time, location, and attendees of a meeting.

Summary and Next Steps

In this lesson, you built upon your previous knowledge of file downloads and learned to upload files to a server using Scala and Requests-Scala. We explored the environment setup, the importance of using requests.MultiPart for file uploads, and methods to send POST requests for file uploads. You also learned how robust error handling with Scala's constructs can lead to more reliable applications. Now, it's time to get hands-on with the practical exercises following this lesson. Use these exercises as an opportunity to reinforce your understanding and experiment with different file types and sizes. This will not only enhance your skills but also prepare you for advanced API interactions in future lessons. Enjoy coding, and keep up the excellent work!

Previous Lesson Next Lesson: Working with Paginated API Responses

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Scala

import requests.*
import scala.util.{Try, Success, Failure}
import java.nio.file.{Paths, Files}
import java.io.File

@main def solution(): Unit =
  val baseUrl = "http://localhost:8000"
  val fileName = "file.txt"
  val filePath = Paths.get(fileName)
  
  Try {
    if !Files.exists(filePath) then 
      throw new java.io.FileNotFoundException(s"File not found: $fileName")
    
    val response = requests.post(
      s"$baseUrl/upload",
      data = requests.MultiPart(
        requests.MultiItem("file", new File(fileName), fileName)
      )
    )
    
    if response.statusCode >= 400 then 
      throw new Exception(s"HTTP error occurred: ${response.statusCode}\n${response.text()}")
    
    println(s"File uploaded successfully: $fileName")
  } match
    case Success(_) => 
    case Failure(e: java.io.FileNotFoundException) =>
      println(e.getMessage)
    case Failure(e) =>
      println(s"Other error occurred: $e")

import requests.*
import scala.util.{Try, Success, Failure}
import java.nio.file.{Paths, Files}
import java.io.File

@main def solution(): Unit =
  val baseUrl = "http://localhost:8000"
  val fileName = "file.txt"
  val filePath = Paths.get(fileName)
  
  Try {
    if !Files.exists(filePath) then 
      throw new java.io.FileNotFoundException(s"File not found: $fileName")
    
    val response = requests.post(
      s"$baseUrl/upload",
      data = requests.MultiPart(
        requests.MultiItem("file", new File(fileName), fileName)
      )
    )
    
    if response.statusCode >= 400 then 
      throw new Exception(s"HTTP error occurred: ${response.statusCode}\n${response.text()}")
    
    println(s"File uploaded successfully: $fileName")
  } match
    case Success(_) => 
    case Failure(e: java.io.FileNotFoundException) =>
      println(e.getMessage)
    case Failure(e) =>
      println(s"Other error occurred: $e")

Scala

import requests.*
import scala.util.{Try, Success, Failure}
import java.nio.file.{Paths, Files}
import java.io.File

@main def solution(): Unit =
  val baseUrl = "http://localhost:8000"
  val fileName = "meeting_notes.txt"
  val filePath = Paths.get(fileName)
  
  Try {
    if !Files.exists(filePath) then 
      throw new java.io.FileNotFoundException(s"File not found: $fileName")
    
    val response = requests.post(
      s"$baseUrl/notes",
      data = requests.MultiPart(
        requests.MultiItem("file", new File(fileName), fileName)
      )
    )
    
    if response.statusCode >= 400 then 
      throw new Exception(s"HTTP error occurred: ${response.statusCode}\n${response.text()}")
    
    println(s"File uploaded successfully: $fileName")
  } match
    case Success(_) => 
    case Failure(e: java.io.FileNotFoundException) =>
      println(e.getMessage)
    case Failure(e) =>
      println(s"Other error occurred: $e")

import requests.*
import scala.util.{Try, Success, Failure}
import java.nio.file.{Paths, Files}
import java.io.File

@main def solution(): Unit =
  val baseUrl = "http://localhost:8000"
  val fileName = "meeting_notes.txt"
  val filePath = Paths.get(fileName)
  
  Try {
    if !Files.exists(filePath) then 
      throw new java.io.FileNotFoundException(s"File not found: $fileName")
    
    val response = requests.post(
      s"$baseUrl/notes",
      data = requests.MultiPart(
        requests.MultiItem("file", new File(fileName), fileName)
      )
    )
    
    if response.statusCode >= 400 then 
      throw new Exception(s"HTTP error occurred: ${response.statusCode}\n${response.text()}")
    
    println(s"File uploaded successfully: $fileName")
  } match
    case Success(_) => 
    case Failure(e: java.io.FileNotFoundException) =>
      println(e.getMessage)
    case Failure(e) =>
      println(s"Other error occurred: $e")

Scala

def verifyUpload(): Unit =
  val baseUrl = "http://localhost:8000"
  val fileName = "meeting_notes.txt"

  Try(requests.get(s"$baseUrl/notes/$fileName")) match
    case Success(response) if response.statusCode == 200 =>
      println(response.text())
    case Success(response) =>
      println(s"Failed to retrieve file with status code: ${response.statusCode}")
    case Failure(exception) =>
      println(s"An error occurred: ${exception.getMessage}")

def verifyUpload(): Unit =
  val baseUrl = "http://localhost:8000"
  val fileName = "meeting_notes.txt"

  Try(requests.get(s"$baseUrl/notes/$fileName")) match
    case Success(response) if response.statusCode == 200 =>
      println(response.text())
    case Success(response) =>
      println(s"Failed to retrieve file with status code: ${response.statusCode}")
    case Failure(exception) =>
      println(s"An error occurred: ${exception.getMessage}")

plaintext

Meeting Notes

Date: 2023-10-18
Time: 3:00 PM
Location: Conference Room A

Attendees:
- Alice Johnson
- Bob Smith
- Charlie Brown
...

Meeting Notes

Date: 2023-10-18
Time: 3:00 PM
Location: Conference Room A

Attendees:
- Alice Johnson
- Bob Smith
- Charlie Brown
...

Scala

import requests.*
import scala.util.{Try, Success, Failure}
import java.nio.file.{Paths, Files}
import java.io.File

@main def solution(): Unit =
  val baseUrl = "http://localhost:8000"
  val fileName = "file.txt"
  val filePath = Paths.get(fileName)
  
  Try {
    if !Files.exists(filePath) then 
      throw new java.io.FileNotFoundException(s"File not found: $fileName")
    
    val response = requests.post(
      s"$baseUrl/upload",
      data = requests.MultiPart(
        requests.MultiItem("file", new File(fileName), fileName)
      )
    )
    
    if response.statusCode >= 400 then 
      throw new Exception(s"HTTP error occurred: ${response.statusCode}\n${response.text()}")
    
    println(s"File uploaded successfully: $fileName")
  } match
    case Success(_) => 
    case Failure(e: java.io.FileNotFoundException) =>
      println(e.getMessage)
    case Failure(e) =>
      println(s"Other error occurred: $e")

Scala

import requests.*
import scala.util.{Try, Success, Failure}
import java.nio.file.{Paths, Files}
import java.io.File

@main def solution(): Unit =
  val baseUrl = "http://localhost:8000"
  val fileName = "meeting_notes.txt"
  val filePath = Paths.get(fileName)
  
  Try {
    if !Files.exists(filePath) then 
      throw new java.io.FileNotFoundException(s"File not found: $fileName")
    
    val response = requests.post(
      s"$baseUrl/notes",
      data = requests.MultiPart(
        requests.MultiItem("file", new File(fileName), fileName)
      )
    )
    
    if response.statusCode >= 400 then 
      throw new Exception(s"HTTP error occurred: ${response.statusCode}\n${response.text()}")
    
    println(s"File uploaded successfully: $fileName")
  } match
    case Success(_) => 
    case Failure(e: java.io.FileNotFoundException) =>
      println(e.getMessage)
    case Failure(e) =>
      println(s"Other error occurred: $e")

Scala

def verifyUpload(): Unit =
  val baseUrl = "http://localhost:8000"
  val fileName = "meeting_notes.txt"

  Try(requests.get(s"$baseUrl/notes/$fileName")) match
    case Success(response) if response.statusCode == 200 =>
      println(response.text())
    case Success(response) =>
      println(s"Failed to retrieve file with status code: ${response.statusCode}")
    case Failure(exception) =>
      println(s"An error occurred: ${exception.getMessage}")

plaintext

Meeting Notes

Date: 2023-10-18
Time: 3:00 PM
Location: Conference Room A

Attendees:
- Alice Johnson
- Bob Smith
- Charlie Brown
...