Need help with Alamofire?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Alamofire
34.8K Stars 6.5K Forks MIT License 1.5K Commits 39 Opened issues

Description

Elegant HTTP Networking in Swift

Services available

!
?

Need anything else?

Contributors list

No Data

Alamofire: Elegant Networking in Swift

Build Status CocoaPods Compatible Carthage Compatible Platform Twitter Gitter Open Source Helpers

Alamofire is an HTTP networking library written in Swift.

Features

  • [x] Chainable Request / Response Methods
  • [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

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 10.0+ / macOS 10.12+ / tvOS 10.0+ / watchOS 3.0+
  • Xcode 11+
  • Swift 5.1+

Migration Guides

Communication

Installation

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
:
pod 'Alamofire', '~> 5.2'

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
:
github "Alamofire/Alamofire" ~> 5.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
Package.swift
.
dependencies: [
    .package(url: "https://github.com/Alamofire/Alamofire.git", .upToNextMajor(from: "5.2.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 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.

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
  • FB7624529
    -
    urlSession(_:task:didFinishCollecting:)
    never called on watchOS

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): 9/1/17 in Xcode 9 beta 6.
  • rdar://36082113
    -
    URLSessionTaskMetrics
    failing to link on watchOS 3.0+
    • (Resolved): Just add
      CFNetwork
      to your linked frameworks.

Workarounds

  • Collection of
    URLSessionTaskMetrics
    is currently disabled on watchOS due to
    FB7624529
    .

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.

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 [email protected] Please do not post it to a public issue tracker.

Donations

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:

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

paypal

License

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.