Elegant HTTP Networking in Swift
Alamofire is an HTTP networking library written in Swift.
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.
UIImageViewextensions, custom image filters, an auto-purging in-memory cache, and a priority-based image downloading system.
URLSessioninstances not managed by Alamofire.
| Platform | Minimum Swift Version | Installation | Status | | --- | --- | --- | --- | | iOS 10.0+ / macOS 10.12+ / tvOS 10.0+ / watchOS 3.0+ | 5.1 | CocoaPods, Carthage, Swift Package Manager, Manual | Fully Tested | | Linux | Latest Only | Swift Package Manager | Building But Unsupported | | Windows | Latest Only | Swift Package Manager | Building But Unsupported |
Alamofire builds on Linux and Windows but there are missing features and many issues in the underlying
swift-corelibs-foundationthat prevent full functionality and may cause crashes. These include: -
ServerTrustManagerand 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
CachedResponseHandlerand associated APIs is unavailable, as the underlying delegate methods aren't called. -
URLSessionTaskMetricsare never gathered.
Due to these issues, Alamofire is unsupported on Linux and Windows. Please report any crashes to the Swift bug reporter.
URLSession, on top of which Alamofire is built.
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
pod 'Alamofire', '~> 5.4'
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
github "Alamofire/Alamofire" ~> 5.4
The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the
swiftcompiler. It is in early development, but Alamofire does support its use on supported platforms.
Once you have your Swift package set up, adding Alamofire as a dependency is as easy as adding it to the
dependenciesvalue of your
dependencies: [ .package(url: "https://github.com/Alamofire/Alamofire.git", .upToNextMajor(from: "5.4.0")) ]
If you prefer not to use any of the aforementioned dependency managers, you can integrate Alamofire into your project manually.
cdinto your top-level project directory, and run the following command "if" your project is not initialized as a git repository:
$ git init
$ git submodule add https://github.com/Alamofire/Alamofire.git
Open the new
Alamofirefolder, and drag the
Alamofire.xcodeprojinto 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.
Alamofire.xcodeprojin 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.xcodeprojfolders each with two different versions of the
Alamofire.frameworknested inside a
It does not matter whichProductsfolder you choose from, but it does matter whether you choose the top or bottomAlamofire.framework.
Select the top
Alamofire.frameworkfor 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 forAlamofirewill be listed asAlamofire iOS,Alamofire macOS,Alamofire tvOS, orAlamofire watchOS.
And that's it!
TheAlamofire.frameworkis 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.
Before contributing to Alamofire, please read the instructions detailed in our contribution guide.
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
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.
URLSessionTaskMetricsfailing to link on watchOS 3.0+
CFNetworkto your linked frameworks.
urlSession(_:task:didFinishCollecting:)never called on watchOS
Alamofire is named after the Alamo Fire flower, a hybrid variant of the Bluebonnet, the official state flower of Texas.
If you believe you have identified a security vulnerability with Alamofire, you should report it as soon as possible via email to [email protected] Please do not post it to a public issue tracker.
The ASF is looking to raise money to officially stay registered as a federal non-profit organization. Registering will allow Foundation members to gain some legal protections and also allow us to put donations to use, tax-free. Donating to the ASF will enable us to:
The community adoption of the ASF libraries has been amazing. We are greatly humbled by your enthusiasm around the projects and want to continue to do everything we can to move the needle forward. With your continued support, the ASF will be able to improve its reach and also provide better legal safety for the core members. If you use any of our libraries for work, see if your employers would be interested in donating. Any amount you can donate today to help us reach our goal would be greatly appreciated.
MacStadium provides Alamofire with a free, hosted Mac mini.
Alamofire is released under the MIT license. See LICENSE for details.