Sending Data with POST Requests in Swift

Sending Data with POST Requests

Welcome to this lesson on sending data with POST requests using Swift. As you continue your exploration of interacting with RESTful APIs, you'll learn how to send data to a server using the POST method. POST requests are essential when creating new resources or submitting data, such as filling out a web form or adding a new entry to a database. Unlike GET requests, which you have already encountered, POST requests transmit data to an API. Understanding these differences is crucial as you expand your skill set in HTTP methods. Let's dive deeper into utilizing POST requests to comprehend how they stand apart from GET requests in Swift.

Key Differences Between GET and POST

Before diving into POST requests, let's briefly compare them to GET requests: GET Requests : Purpose : Retrieve data from a server. Data Location : Data is sent in the URL as path or query parameters. Success Status : Expect a 200 status code for successful data retrieval. POST Requests : Purpose : Send data to a server to create or update a resource, such as submitting a form or adding a new item to a database. Data Location : Data is sent in the request body. Success Status : Expect a 201 status code for successful resource creation. Another important difference between GET and POST is security and data visibility. Since GET requests append data to the URL as query parameters, this data is stored in browser history, logged in servers, and visible in network tools. This makes GET unsuitable for sensitive data, such as passwords or personal information. In contrast, POST requests send data in the body, making them less exposed. These differences clarify when to use each method. POST requests, in particular, require careful handling of the request body.

Understanding the Request Body

For POST requests, the request body is crucial as it holds the data you want to send to the server. This data is usually structured in formats like JSON, which is common due to its readability and compatibility. Here is an example of a Swift structure for a JSON request body: Swift struct Todo: Codable {let title: String let description: String let done: Bool} let newTodo = Todo(title: "Learn Swift URLSession", description: "Complete a course on Swift API calls.", done: false) This represents a new todo item, including a title, completion status, and description. Noticeably, we are not sending an id, as this is typically managed by the server upon resource creation.

Join the 1M+ learners on CodeSignal

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

Crafting a Post Request: Adding a New Todo

Let's walk through an example of how to craft a POST request to add a new todo item to our API.

First, we will need to prepare the data we wish to send. We will be adding a new todo item with a specific title, a completion status, and a description:

Swift

let newTodo = Todo(title: "Learn Swift URLSession", description: "Complete a course on Swift API calls.", done: false)

guard let url = URL(string: "\(baseURL)/todos") else { return }

var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("application/json", forHTTPHeaderField: "Content-Type")

let encoder = JSONEncoder()
do {
    request.httpBody = try encoder.encode(newTodo)
} catch {
    print("Failed to encode new todo: \(error)")
    return
}

let newTodo = Todo(title: "Learn Swift URLSession", description: "Complete a course on Swift API calls.", done: false)

guard let url = URL(string: "\(baseURL)/todos") else { return }

var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("application/json", forHTTPHeaderField: "Content-Type")

let encoder = JSONEncoder()
do {
    request.httpBody = try encoder.encode(newTodo)
} catch {
    print("Failed to encode new todo: \(error)")
    return
}

In Swift, you use URLSession to send the request:

Swift

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let httpResponse = response as? HTTPURLResponse, httpResponse.statusCode == 201,
          let data = data else {
        print("Failed to add a new todo")
        return
    }
    
    do {
        let createdTodo = try JSONDecoder().decode(Todo.self, from: data)
        print("New todo added successfully!")
        print("Created Todo: \(createdTodo)")
    } catch {
        print("Failed to decode response: \(error)")
    }
}

task.resume()

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let httpResponse = response as? HTTPURLResponse, httpResponse.statusCode == 201,
          let data = data else {
        print("Failed to add a new todo")
        return
    }
    
    do {
        let createdTodo = try JSONDecoder().decode(Todo.self, from: data)
        print("New todo added successfully!")
        print("Created Todo: \(createdTodo)")
    } catch {
        print("Failed to decode response: \(error)")
    }
}

task.resume()

Sending Data with POST Requests

Key Differences Between GET and POST

Understanding the Request Body

Join the 1M+ learners on CodeSignal

Utilizing URLSession for POST Operations

Crafting a Post Request: Adding a New Todo

Handling Responses and Error Management

Summary and Overview of Practice Exercises