Alamofire is an HTTP networking library written in Swift.
⚠️⚠️⚠️ WARNING ⚠️⚠️⚠️ This documentation is out of date during the Alamofire 5 beta process.
- Component Libraries
- Migration Guides
- Advanced Usage
- Open Radars
- [x] Chainable Request / Response Methods
- [x] URL / JSON / plist 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
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,
UIImageViewextensions, 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
URLSessioninstances not managed by Alamofire.
- iOS 10.0+ / macOS 10.12+ / tvOS 10.0+ / watchOS 3.0+
- Xcode 10.2+
- Swift 5+
- Alamofire 5.0 Migration Guide: To be written!
- Alamofire 4.0 Migration Guide
- Alamofire 3.0 Migration Guide
- Alamofire 2.0 Migration Guide
- If you need help with making network requests using Alamofire, use Stack Overflow and tag
- 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!
- If you want to contribute, submit a pull request.
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.0.0-rc.2'
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.0.0-rc.2"
Swift Package Manager
The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the
swift compiler. 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
dependencies value of your
dependencies: [ .package(url: "https://github.com/Alamofire/Alamofire.git", from: "5.0.0-rc.2") ]
If you prefer not to use any of the aforementioned dependency managers, you can integrate Alamofire into your project manually.
Open up Terminal,
cdinto your top-level project directory, and run the following command "if" your project is not initialized as a git repository:
$ git init
Add Alamofire as a git submodule by running the following command:
$ 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 which
Productsfolder you choose from, but it does matter whether you choose the top or bottom
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 for
Alamofirewill be listed as either
And that's it!
Alamofire.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.
The following radars have some effect on the current implementation of Alamofire.
rdar://21349340- Compiler throwing warning due to toll-free bridging issue in 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.
- (Resolved): 9/1/17 in Xcode 9 beta 6.
URLSessionTaskMetricsfailing to link on watchOS 3.0+
- (Resolved): Just add
CFNetworkto your linked frameworks.
- (Resolved): Just add
What's the origin of the name Alamofire?
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@example.com. 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 us 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:
- Pay our yearly legal fees to keep the non-profit in good status
- Pay for our mail servers to help us stay on top of all questions and security issues
- Potentially fund test servers to make it easier for us to test the edge cases
- Potentially fund developers to work on one of our projects full-time
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.
Alamofire is released under the MIT license. See LICENSE for details.
Help us keep the lights on
5.0.0-rc.2 - Sep 8, 2019
5.0.0-rc.1 - Sep 4, 2019
Released on 2019-09-04. All issues associated with this milestone can be found using this filter. Note: Alamofire 5 is now API stable.
Sessionto cancel all in flight requests.
- Ability to inject
DataPreprocessorprotocol and implementations, allowing the preprocessing of data before serialization.
URLRequestvalidation and error.
GETrequests with body data will now produce an error.
DownloadResponse, making them
DataResponse<Success, Failure: Error>and
DownloadResponse<Success, Failure: Error>.
- Precondition to ensure
Sessioncan't be used with background
URLSessionConfigurations. Alamofire will explicitly support such functionality at some point in the future.
- SwiftFormat configuration and updated styling.
AFDownloadResponse<Success>typealiases to help deal with the doubly generic responses.
- All internal
Resultusage to use the fully qualified type instead of
DownloadRequestfunctional API, renaming
HTTPMethodto be a struct rather than an enum.
- All errors produced by Alamofire to be
AFErrorby default. All responses will now start with an
NetworkReachabilityManagerto simplify and modernize its API.
Usage.mddocumentation to be fully up-to-date with Alamofire 5.
- Bundle identifiers to include the platform name, fixing ITMS-90806.
4.9.0 - Sep 4, 2019
Released on 2019-09-03. All issues associated with this milestone can be found using this filter.
- API to cancel
DownloadRequests without producing resume data.
- Bundle identifiers to include the platform name, fixing ITMS-90806.
5.0.0-beta.7 - Jul 30, 2019
Released on 2019-07-29. All issues associated with this milestone can be found using this filter. Note: Alamofire will not be following semantic versioning during the beta process. There may be breaking changes until 5.0.0 is released.
URLEncodedFormEncoder.KeyEncodingto customize the encoding of
cURLDescriptionmethod to produce
Requests which are in the process of creating their initial
- All inline API documentation.
- Handling of response serializers appended after a
Requesthas completed. This no longer produces an error but will instead trigger the normal
5.0.0-beta.6 - Apr 24, 2019
Released on 2019-04-23. All issues associated with this milestone can be found using this filter. Note: Alamofire will not be following semantic versioning during the beta process. There may be breaking changes until 5.0.0 is released.
ServerTrustEvaluationlogic by simplifying public key equality checks for
Request.Stateaccess to lock access and task updates using internal locking API.
- Issues in
DownloadRequestwhere some events were being duplicated and some were missing.
- Issue with AppStore submissions where the pre-release version in the bundle short versions string was being rejected when built with Carthage or as a submodule.
- Issue where response serializer completions were not called when appended to a completed