Alamofire

Elegant HTTP Networking in Swift

Star full 4f7b624809470f25b6493d5a7b30d9b9cb905931146e785d67c86ef0c205a402Star full 4f7b624809470f25b6493d5a7b30d9b9cb905931146e785d67c86ef0c205a402Star full 4f7b624809470f25b6493d5a7b30d9b9cb905931146e785d67c86ef0c205a402Star full 4f7b624809470f25b6493d5a7b30d9b9cb905931146e785d67c86ef0c205a402Star half bd79095782ee4930099175e5ce7f4c89fa3ddabcd56fffcc7c74f6f2a2d46b27 (1 ratings)
Rated 4.5 out of 5
Subscribe to updates I use Alamofire


Statistics on Alamofire

Number of watchers on Github 27197
Number of open issues 37
Average time to close an issue 2 days
Main language Swift
Average time to merge a PR 7 days
Open pull requests 66+
Closed pull requests 135+
Last commit 9 months ago
Repo Created over 4 years ago
Repo Last Updated 8 months ago
Size 5.3 MB
Organization / Authoralamofire
Latest Release4.7.0
Contributors77
Page Updated
Do you use Alamofire? Leave a review!
View open issues (37)
View Alamofire activity
View on github
Latest Open Source Launches
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating Alamofire for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

Alamofire: Elegant Networking in Swift

Build Status CocoaPods Compatible Carthage Compatible Platform Twitter Gitter

Alamofire is an HTTP networking library written in Swift.

Features

  • [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

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

  • iOS 8.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+
  • Xcode 8.3+
  • Swift 3.1+

Migration Guides

Communication

  • If you need help, use Stack Overflow. (Tag 'alamofire')
  • If you'd like to ask a general question, use Stack Overflow.
  • If you found a bug, open an issue.
  • If you have a feature request, open an issue.
  • If you want to contribute, submit a pull request.

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

CocoaPods 1.1+ is required to build Alamofire 4.0+.

To integrate Alamofire into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'Alamofire', '~> 4.7'
end

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Alamofire into your Xcode project using Carthage, specify it in your Cartfile:

github "Alamofire/Alamofire" ~> 4.7

Run carthage update to build the framework and drag the built Alamofire.framework into your Xcode project.

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 Package.swift.

Swift 3

dependencies: [
    .Package(url: "https://github.com/Alamofire/Alamofire.git", majorVersion: 4)
]

Swift 4

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

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:
  $ 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 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 OS X.

    You can verify which one you selected by inspecting the build log for your project. The build target for Alamofire will be listed as either 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.

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 test case
  • rdar://26870455 - Background URL Session Configurations do not work in the simulator
  • rdar://26849668 - Some URLProtocol APIs do not properly handle URLRequest
  • rdar://36082113 - URLSessionTaskMetrics failing to link on watchOS 3.0+

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 on 9/1/17 in Xcode 9 beta 6).

FAQ

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.

What logic belongs in a Router vs. a Request Adapter?

Simple, static data such as paths, parameters and common headers belong in the Router. Dynamic data such as an Authorization header whose value can changed based on an authentication system belongs in a RequestAdapter.

The reason the dynamic data MUST be placed into the RequestAdapter is to support retry operations. When a Request is retried, the original request is not rebuilt meaning the Router will not be called again. The RequestAdapter is called again allowing the dynamic data to be updated on the original request before retrying the Request.

Credits

Alamofire is owned and maintained by the Alamofire Software Foundation. You can follow them on Twitter at @AlamofireSF for project updates and releases.

Security Disclosure

If you believe you have identified a security vulnerability with Alamofire, you should report it as soon as possible via email to security@alamofire.org. Please do not post it to a public issue tracker.

Donations

The ASF is looking to raise money to officially register 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 legal fees to register as a federal non-profit organization
  • 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. Our initial goal is to raise $1000 to get all our legal ducks in a row and kickstart this campaign. Any amount you can donate today to help us reach our goal would be greatly appreciated.

License

Alamofire is released under the MIT license. See LICENSE for details.

Alamofire open issues Ask a question     (View All Issues)
  • about 2 years I need to measure latency of calls
  • about 2 years Archiving project with XCode 8.1 & Swift 3 gives a linker error.
  • about 2 years Response is nil by using of a default URLSessionConfiguration in SessionManager
  • about 2 years submit an app to App store with these error???
  • about 2 years Issue when update image Multipart
  • about 2 years Error Object deserialization with ObjectMapper
  • about 2 years Error Code=-999
  • about 2 years Problem while adding "Alamofire 4.0" using carthage
  • about 2 years Xcode 8.2 will be the last release to support SWIFT 2.3, are we obliged to migrate to Alamofire 4?
  • about 2 years troubles with making requests after migrating from version 3 to 4
  • about 2 years Is multipart/mixed content type supported?
  • about 2 years Alamofire Code=-999 "cancelled"
  • about 2 years data Encoding.windowsCP1251 and .responseJSON
  • about 2 years Alamofire not working well with swift 3
  • about 2 years Module compiled with Swift 3.0 cannot be imported in Swift 3.0.1
  • about 2 years Alamofire upload huge file
  • about 2 years SSL check at runtime
  • about 2 years NSPOSIXErrorDomain Code=100 swift3, Alamofire 4
  • about 2 years Release new version with fixed Package.swift
  • about 2 years Sequential Requests - Swift 3, Xcode 8, Alamofire 4
  • about 2 years Swift 3.0.1: /Carthage/Checkouts/Alamofire/Source/Request.swift:474:47: warning: expression implicitly coerced from 'URLSessionTask?' to Any
  • about 2 years Alamofire.upload with Multipart Form Data isn't removing temporary files after the request finished
  • about 2 years SessionManager.swift DispatchQueue
  • about 2 years building success but launch app crashed , how to fix it ?
  • about 2 years cannot call value of non-function type 'HTTPURLResponse'
  • about 2 years hot to make a soap request in swift 3
  • about 2 years Alamofire.upload issue
  • about 2 years Crash in DataTaskDelegate
  • about 2 years Xcode 8.1 Compiler warning
  • about 2 years 'utility' is inaccessible due to 'internal' protection
Alamofire open pull requests (View All Pulls)
  • Simplify project setup, reduce number of framework and test targets
  • Feature - Override Closures with Completion
  • Requests with invalid credentials should terminate with a 401 code
  • Allow default delegation controlled via property on SessionDelegate
  • Adjust the order
  • Using `stringByAddingPercentEncodingWithAllowedCharacters()` to promi…
  • Updated character
  • Add `basicAuthenticationHeader` function
  • Fixes Request.debugPrint to coalesce headers
  • Convert URL date parameters to ISO8601 format
  • Update README to reflect error best practices.
  • Made non-deprecated functions public in Error.swift :)
  • 1 > 0
  • Test call of session:didReceiveChallenge in background session
  • Fix - String Interpolation Leaks
  • Update README.md - remove deprecated functions
  • Update 'Generic Response Object Serialization' section on README by using protocol extension
  • [wip] Swift 2.3 Compatibility
  • Swift lint parsing
  • JSON parameters shouldn't be expected to be in a particular order
  • Add 'public' to enum 'BackendError'
  • hold the original NSMutableURLRequest's allHTTPHeaderField and cacheP…
  • WIP: New Error Handling
  • Feature - Parameter Encoding Safety
  • Feature - Throwing Adapt Error Calls Retrier
  • Fix crash in TaskDelegate
  • Empty bodies for GET, HEAD and DELETE methods.
  • Readme fix DataResponse
  • Use HTTP header's Host to validate if existed
  • Remove uses of internal API from Alamofire 4 Migration Guide
  • Fix Xcode 8.1 Warnings
  • Fix typo: URLSessionManagerConfiguration -> URLSessionConfiguration
  • Update Alamofire 4.0 Migration Guide.md
  • Functional extensions for Result, DataResponse, DownloadResponse
  • Added new server trust policy: Revocation
  • Fix super minor language error in README
  • Update ResponseTests.swift
  • AFError conform to CustomNSError
  • Delete: Warning
  • enable setter of the MultipartFormData's contentType
  • Use curl -v instead of curl -i in cURLRepresentation()
  • Issue #2052 - Change reachability computation
  • Remove redundant optional unwrap
  • Added missing charset to JSONEncoding.encode()
  • Add the execution result of example in README.md
  • ResultTests: Small updates and typos fix
  • Removes the old request to avoid endless growth.
  • Minor documentation update on testing Alamofire via a command line a…
  • Update Installation guide to current version
  • requestRetrier should doesn't work immediately when the request had been canceled
  • Set appropriate protection levels on NetworkReachabilityManager members
  • Clarify OS versions affected by download resume bug
  • Alamofire 5!
  • Fix 'characters' is deprecated
  • Requests taking Encodable parameters
  • Enable injection of FileManager
  • Brotli Accept-Encoding Support
  • Refactor ServerTrustPolicy
  • adding test that retried request is canceled while delay
  • Add PathComponents parameter encoding
  • Add configurable array parameter handling to URLEncoding.
  • extend userInfo-dict of .DidComplete-Notification to contain responseData of DataTasks
  • Typo in the example code - one missing (
  • fixed: cookies not shown in cURLRepresentation
  • Add documentation to address #2402
  • Add CodeTriage badge to alamofire/alamofire
Alamofire questions on Stackoverflow (View All Questions)
  • Alamofire and JSONAPI
  • Upload image with alamofire
  • Uploading file with parameters using Alamofire
  • How to use Alamofire post data with parameters in SWIFT
  • How to send data to table view with Alamofire And SwiftyJSON
  • Alamofire MultiPartForm files in NSTemporaryDirectory
  • Swift 2.0 with Alamofire: How to send http headers with X-WSSE Authorization?
  • Swift HTTP Stub doesn't work. (Alamofire 3.0 & Mockingjay)
  • Adding a jsonString to Alamofire request
  • Alamofire Serial Requests
  • Alamofire response not matching request
  • Unable to upload directly to S3 with Alamofire
  • setHTTPShouldHandleCookies in Alamofire
  • Multipart-form (image,parameters,headers) Post request with Alamofire in swift
  • How to parse JSON response from Alamofire API in Swift?
  • How to implement self signed certificates in Alamofire?
  • Cannot select json array from rest api using Alamofire
  • iOS Swift 2 - Alamofire print response value when Failure
  • Alamofire not handling Authentication challenge
  • Alamofire: how to handle and classify errors?
  • Alamofire json post order in Swift 2
  • swift - Create new class for getting api with alamofire but can't dealing with async
  • Alamofire, Objectmapper, Realm: Nested Objects
  • Alamofire sends request ip6 format
  • iOS swift using alamofire to share cookie between app and share extension
  • Swift Alamofire Activitylogger
  • How can I log each request/response using Alamofire?
  • Alamofire ObjectMapper, Int to enum is incorrect
  • Cannot conform to URLRequestConvertible with Alamofire?
  • How to no need authorise again when using Alamofire?
Alamofire list of languages used
Alamofire latest release notes
4.7.0 Openness and Configurability

All issues associated with this milestone can be found using this filter.

Added

  • Open accessibility to NetworkReachabilityManager
  • Configurable parameter encodding for URLEncoding
  • Response Data to .DidComplete notification.
  • Radar link for URLSessionTaskMetrics bug on watchOS.

Updated

  • Project for Xcode 9.3 and Swift 4.1.
  • OS versions affected by resume data bug.

Fixed

4.6.0 Refinement Towards the Future

Released on 2017-12-3. All issues associated with this milestone can be found using this filter.

Added

  • Error mapping functions to Response types.
  • Separation of Usage and Advanced Usage docs from README.

Updated

Fixed

4.5.1 Swift 3.2 and Xcode 9

Released on 2017-09-06. All issues associated with this milestone can be found using this filter.

Added

  • GitHub templates for issues and pull requests.
  • Jazzy docs for the release to work with GitHub Pages.
  • Dash support for Jazzy docs.

Updated

  • The project to work with Xcode 9 beta 6 on Swift 3.2 and 4.0.
  • The Travis CI config to work with Xcode 9 beta 6.
  • The cURL representation logic to no longer force unwrap URLCredential values.
  • The radars section of the README to split out open vs. resolved radars.
  • The installation section of the README to use the current version.

Fixed

  • Issue in TaskDelegate where task access was not thread safe.
  • Issue in AF 4 migration guide where supported iOS versions was incorrect.
  • Issue in README sample code where PNG representation API was incorrect.
  • Swift 3.2+ API warnings for substring APIs.
Other projects in Swift