Alamofire ORG

!Alamofire: Elegant Networking in Swift


Alamofire is an HTTP networking library written in Swift.

• [Features](#features)
• [Component Libraries](#component-libraries)
• [Requirements](#requirements)
• [Migration Guides](#migration-guides)
• [Communication](#communication)
• [Installation](#installation)
• [Contributing](#contributing)
• Usage

- Introduction - Making Requests, Response Handling, Response Validation, Response Caching - HTTP - HTTP Methods, Parameters and Parameter Encoder, HTTP Headers, Authentication - Large Data - Downloading Data to a File, Uploading Data to a Server - Tools - Statistical Metrics, cURL Command Output

• Advanced Usage

- URL Session - Session Manager, Session Delegate, Request - Routing - Routing Requests, Adapting and Retrying Requests - Model Objects - Custom Response Handlers - Advanced Concurrency - Swift Concurrency and Combine - Connection - Security, Network Reachability

• [Open Radars](#open-radars)
• [FAQ](#faq)
• [Credits](#credits)
• [Donations](#donations)
• [License](#license)

Features

• [x] Chainable Request / Response Methods
• [x] Swift Concurrency Support Back to iOS 13, macOS 10.15, tvOS 13, and watchOS 6.
• [x] Combine Support
• [x] URL / JSON Parameter Encoding
• [x] Upload File / Data / Stream / MultipartFormData
• [x] Download File using Request or Resume Data
• [x] Authentication with URLCredential
• [x] HTTP Response Validation
• [x] Upload and Download Progress Closures with Progress
• [x] cURL Command Output
• [x] Dynamically Adapt and Retry Requests
• [x] TLS Certificate and Public Key Pinning
• [x] Network Reachability
• [x] Comprehensive Unit and Integration Test Coverage
• [x] Complete Documentation

Write Requests Fast!

Alamofire's compact syntax and extensive feature set allow requests with powerful features like automatic retry to be written in just a few lines of code.

swift
// Automatic String to URL conversion, Swift concurrency support, and automatic retry.
let response = await AF.request("https://httpbin.org/get", interceptor: .retryPolicy)
                       // Automatic HTTP Basic Auth.
                       .authenticate(username: "user", password: "pass")
                       // Caching customization.
                       .cacheResponse(using: .cache)
                       // Redirect customization.
                       .redirect(using: .follow)
                       // Validate response code and Content-Type.
                       .validate()
                       // Produce a cURL command for the request.
                       .cURLDescription { description in
                         print(description)
                       }
                       // Automatic Decodable support with background parsing.
                       .serializingDecodable(DecodableType.self)
                       // Await the full response with metrics and a parsed body.
                       .response
// Detailed response description for easy debugging.
debugPrint(response)

Component Libraries

In order to keep Alamofire focused specifically on core networking implementations, additional component libraries have been created by the Alamofire Software Foundation to bring additional functionality to the Alamofire ecosystem.

• AlamofireImage - An image library including image response serializers, UIImage and UIImageView extensions, custom image filters, an auto-purging in-memory cache, and a priority-based image downloading system.
• AlamofireNetworkActivityIndicator - Controls the visibility of the network activity indicator on iOS using Alamofire. It contains configurable delay timers to help mitigate flicker and can support URLSession instances not managed by Alamofire.

Requirements

| Platform | Minimum Swift Version | Installation | Status |
| ---------------------------------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| iOS 10.0+ / macOS 10.12+ / tvOS 10.0+ / watchOS 3.0+ | 6.0 / Xcode 16.0 | [CocoaPods](#cocoapods), [Carthage](#carthage), [Swift Package Manager](#swift-package-manager), [Manual](#manually) | Fully Tested |
| Linux | Latest Only | [Swift Package Manager](#swift-package-manager) | Building But Unsupported |
| Windows | Latest Only | [Swift Package Manager](#swift-package-manager) | Building But Unsupported |
| Android | Latest Only | [Swift Package Manager](#swift-package-manager) | Building But Unsupported |

Known Issues on Linux and Windows

Alamofire builds on Linux, Windows, and Android but there are missing features and many issues in the underlying swift-corelibs-foundation that prevent full functionality and may cause crashes. These include:

• ServerTrustManager and associated certificate functionality is unavailable, so there is no certificate pinning and no client certificate support.
• Various methods of HTTP authentication may crash, including HTTP Basic and HTTP Digest. Crashes may occur if responses contain server challenges.
• Cache control through CachedResponseHandler and associated APIs is unavailable, as the underlying delegate methods aren't called.
• URLSessionTaskMetrics are never gathered.
• WebSocketRequest is not available.

Due to these issues, Alamofire is unsupported on Linux, Windows, and Android. Please report any crashes to the Swift bug reporter.

Migration Guides

• Alamofire 5.0 Migration Guide
• Alamofire 4.0 Migration Guide
• Alamofire 3.0 Migration Guide
• Alamofire 2.0 Migration Guide

Communication

• If you need help with making network requests using Alamofire, use Stack Overflow and tag alamofire.
• If you need to find or understand an API, check our documentation or Apple's documentation for URLSession, on top of which Alamofire is built.
• If you need help with an Alamofire feature, use our forum on swift.org.
• If you'd like to discuss Alamofire best practices, use our forum on swift.org.
• If you'd like to discuss a feature request, use our forum on swift.org.
• If you found a bug, open an issue here on GitHub and follow the guide. The more detail the better!

Installation

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.

Once you have your Swift package set up, adding Alamofire as a dependency is as easy as adding it to the dependencies value of your Package.swift or the Package list in Xcode.

swift
dependencies: [
    .package(url: "https://github.com/Alamofire/Alamofire.git", .upToNextMajor(from: "5.11.0"))
]

Normally you'll want to depend on the Alamofire target:

swift
.product(name: "Alamofire", package: "Alamofire")

But if you want to force Alamofire to be dynamically linked (do not do this unless you're sure you need it), you can depend on the AlamofireDynamic target:

swift
.product(name: "AlamofireDynamic", package: "Alamofire")

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate Alamofire into your Xcode project using CocoaPods, specify it in your Podfile:

ruby
pod 'Alamofire'

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate Alamofire into your Xcode project using Carthage, specify it in your Cartfile:

ogdl
github "Alamofire/Alamofire"

Manually

If you prefer not to use any of the aforementioned dependency managers, you can integrate Alamofire into your project manually.

Embedded Framework

• Open up Terminal, cd into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:

bash
  $ git init

• Add Alamofire as a git submodule by running the following command:

bash
  $ git submodule add https://github.com/Alamofire/Alamofire.git

• Open the new Alamofire folder, and drag the Alamofire.xcodeproj into the Project Navigator of your application's Xcode project.

> It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.

• Select the Alamofire.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.
• Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
• In the tab bar at the top of that window, open the "General" panel.
• Click on the + button under the "Embedded Binaries" section.
• You will see two different Alamofire.xcodeproj folders each with two different versions of the Alamofire.framework nested inside a Products folder.

> It does not matter which Products folder you choose from, but it does matter whether you choose the top or bottom Alamofire.framework.

• Select the top Alamofire.framework for iOS and the bottom one for macOS.

> You can verify which one you selected by inspecting the build log for your project. The build target for Alamofire will be listed as Alamofire iOS, Alamofire macOS, Alamofire tvOS, or Alamofire watchOS.

• And that's it!

> The Alamofire.framework is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.

Contributing

Before contributing to Alamofire, please read the instructions detailed in our contribution guide.

Open Radars

The following radars have some effect on the current implementation of Alamofire.

• rdar://21349340 - Compiler throwing warning due to toll-free bridging issue in the test case
• rdar://26870455 - Background URL Session Configurations do not work in the simulator
• rdar://26849668 - Some URLProtocol APIs do not properly handle URLRequest

Resolved Radars

The following radars have been resolved over time after being filed against the Alamofire project.

• rdar://26761490 - Swift string interpolation causing memory leak with common usage.

- (Resolved):

…

Collapse