POST request with JSON body in iOS Swift

Introduction

We use POST requests with JSON body to send data from your app to a server. This helps you save or update information online.

When a user submits a form like signing up or logging in.

When sending a message or comment to a chat or social app.

When uploading settings or preferences to your account.

When creating a new item like a post, photo, or task in an app.

Syntax

iOS Swift

let url = URL(string: "https://example.com/api")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("application/json", forHTTPHeaderField: "Content-Type")

let json: [String: Any] = ["key": "value"]
let jsonData = try? JSONSerialization.data(withJSONObject: json)

request.httpBody = jsonData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  // handle response here
}
task.resume()

Set the HTTP method to "POST" to tell the server you want to send data.

Set the "Content-Type" header to "application/json" to specify the data format.

Examples

Send login info as JSON in the POST request body.

iOS Swift

var request = URLRequest(url: URL(string: "https://api.example.com/login")!)
request.httpMethod = "POST"
request.setValue("application/json", forHTTPHeaderField: "Content-Type")

let body = ["username": "user1", "password": "pass123"]
request.httpBody = try? JSONSerialization.data(withJSONObject: body)

Create a new task by sending its details as JSON.

iOS Swift

var request = URLRequest(url: URL(string: "https://api.example.com/tasks")!)
request.httpMethod = "POST"
request.setValue("application/json", forHTTPHeaderField: "Content-Type")

let taskData = ["title": "Buy milk", "done": false] as [String : Any]
request.httpBody = try? JSONSerialization.data(withJSONObject: taskData)

Sample App

This example sends a POST request with a JSON body to a test API. It prints the server's JSON response in the console.

iOS Swift

import UIKit

class ViewController: UIViewController {
  override func viewDidLoad() {
    super.viewDidLoad()
    sendPostRequest()
  }

  func sendPostRequest() {
    guard let url = URL(string: "https://jsonplaceholder.typicode.com/posts") else { return }
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")

    let jsonBody: [String: Any] = ["title": "foo", "body": "bar", "userId": 1]
    request.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody)

    let task = URLSession.shared.dataTask(with: request) { data, response, error in
      if let error = error {
        print("Error: \(error.localizedDescription)")
        return
      }
      guard let data = data else {
        print("No data received")
        return
      }
      if let responseJSON = try? JSONSerialization.jsonObject(with: data) as? [String: Any] {
        print("Response JSON: \(responseJSON)")
      }
    }
    task.resume()
  }
}

Important Notes

Always set the Content-Type header to "application/json" when sending JSON data.

Use URLSession's dataTask to send the request asynchronously.

Handle errors and check the response to know if the request succeeded.

Summary

POST requests send data to a server, often to create or update something.

JSON is a common format to send structured data in the request body.

Set the HTTP method and headers correctly to make the server understand your data.

Practice

1. What is the main purpose of a POST request with a JSON body in iOS Swift networking?

easy

A. To send data to a server, usually to create or update resources

B. To retrieve data from a server without sending any data

C. To delete data from a server

D. To open a WebSocket connection

Solution

1. Step 1: Understand HTTP methods

   POST requests are used to send data to a server, often to create or update something.

2. Step 2: Recognize JSON role

   JSON is a format to structure the data sent in the body of the POST request.

3. Final Answer:

   To send data to a server, usually to create or update resources -> Option A

4. Quick Check:

   POST sends data = A [OK]

Hint: POST means send data to server, not just get [OK]

Common Mistakes:

• Confusing POST with GET method
• Thinking POST is for deleting data
• Ignoring the role of JSON in the body

2. Which Swift code snippet correctly sets the HTTP method to POST and adds a JSON Content-Type header?

easy

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

B. request.method = "POST"
request.addHeader("Content-Type", value: "application/json")

C. request.httpMethod = POST
request.setHeader("Content-Type", "application/json")

D. request.method = POST
request.setValue("json", forHTTPHeaderField: "Content-Type")

Solution

1. Step 1: Set HTTP method correctly

   The property to set HTTP method in URLRequest is httpMethod and it expects a String like "POST".

2. Step 2: Add JSON Content-Type header properly

   Use setValue(_:forHTTPHeaderField:) with "application/json" for the "Content-Type" header.

3. Final Answer:

   request.httpMethod = "POST"\nrequest.setValue("application/json", forHTTPHeaderField: "Content-Type") -> Option A

4. Quick Check:

   Correct method and header syntax = A [OK]

Hint: Use request.httpMethod and setValue for headers [OK]

Common Mistakes:

• Using wrong property names like method or setHeader
• Forgetting quotes around "POST"
• Using incorrect header field names or values

3. Given the Swift code below, what will be the printed output?

let url = URL(string: "https://example.com/api")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let jsonBody = ["name": "Alice", "age": 30] as [String : Any]
request.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody)
print(String(data: request.httpBody!, encoding: .utf8)!)

medium

A. ["name": "Alice", "age": 30]

B. {"name":"Alice","age":30}

C. Optional({"name":"Alice","age":30})

D. nil

Solution

1. Step 1: Serialize dictionary to JSON data

   JSONSerialization.data converts the dictionary to JSON data bytes representing {"name":"Alice","age":30}.

2. Step 2: Convert data to UTF-8 string

   Printing the data as UTF-8 string shows the JSON string without brackets or Optional wrapper.

3. Final Answer:

   {"name":"Alice","age":30} -> Option B

4. Quick Check:

   JSONSerialization outputs JSON string = B [OK]

Hint: JSONSerialization outputs JSON string, not Swift dictionary syntax [OK]

Common Mistakes:

• Expecting Swift dictionary syntax instead of JSON string
• Printing Optional wrapper
• Forgetting to unwrap data or encoding

4. Identify the error in this Swift code for sending a POST request with JSON body:

var request = URLRequest(url: URL(string: "https://api.example.com")!)
request.httpMethod = "POST"
let json = ["key": "value"]
request.httpBody = try? JSONSerialization.jsonObject(with: json)

medium

A. httpMethod should be lowercase "post"

B. Missing setting Content-Type header to application/json

C. Using JSONSerialization.jsonObject instead of data(withJSONObject:)

D. URLRequest initialization is incorrect

Solution

1. Step 1: Check JSON serialization method

   jsonObject(with:) parses JSON data to object; to create JSON data from object, use data(withJSONObject:).

2. Step 2: Confirm other parts

   Content-Type header missing is an issue but not the main error causing failure here.

3. Final Answer:

   Using JSONSerialization.jsonObject instead of data(withJSONObject:) -> Option C

4. Quick Check:

   Wrong JSON method used = D [OK]

Hint: Use data(withJSONObject:) to create JSON data, not jsonObject(with:) [OK]

Common Mistakes:

• Confusing jsonObject(with:) with data(withJSONObject:)
• Forgetting Content-Type header
• Incorrect URLRequest initialization

5. You want to send a POST request with a JSON body containing user info, but only include the "email" field if it is not empty. Which Swift code snippet correctly creates the JSON body for this conditional inclusion?

hard

A. var jsonBody = ["name": "Bob", "email": email]
if !email.isEmpty {
jsonBody.removeValue(forKey: "email")
}
request.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody)

B. let jsonBody = ["name": "Bob", "email": email.isEmpty ? nil : email]
request.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody)

C. let jsonBody = ["name": "Bob"]
if email != "" {
jsonBody["email"] = email
}
request.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody)

D. var jsonBody = ["name": "Bob"]
if !email.isEmpty {
jsonBody["email"] = email
}
request.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody)

Solution

1. Step 1: Understand conditional dictionary update

   var jsonBody = ["name": "Bob"] if !email.isEmpty { jsonBody["email"] = email } request.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody) creates a mutable dictionary and adds "email" only if not empty, which is correct.

2. Step 2: Check other options for errors

   let jsonBody = ["name": "Bob", "email": email.isEmpty ? nil : email] request.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody) uses nil in dictionary literal which is invalid; var jsonBody = ["name": "Bob", "email": email] if !email.isEmpty { jsonBody.removeValue(forKey: "email") } request.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody) uses inverted condition, removing email when it is not empty, incorrect; let jsonBody = ["name": "Bob"] if email != "" { jsonBody["email"] = email } request.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody) tries to mutate immutable dictionary.

3. Final Answer:

   var jsonBody = ["name": "Bob"]\nif !email.isEmpty {\n jsonBody["email"] = email\n}\nrequest.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody) -> Option D

4. Quick Check:

   Mutable dict + conditional add = C [OK]

Hint: Use var dictionary and add keys conditionally [OK]

Common Mistakes:

• Using let dictionary and trying to mutate it
• Including nil values in dictionary literal
• Adding then removing keys instead of conditional add