iOS/Pods/Alamofire/README.md

   1 ![Alamofire: Elegant Networking in Swift](https://raw.githubusercontent.com/Alamofire/Alamofire/master/alamofire.png)
   2
   3 [![Build Status](https://travis-ci.org/Alamofire/Alamofire.svg?branch=master)](https://travis-ci.org/Alamofire/Alamofire)
   4 [![CocoaPods Compatible](https://img.shields.io/cocoapods/v/Alamofire.svg)](https://img.shields.io/cocoapods/v/Alamofire.svg)
   5 [![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
   6 [![Platform](https://img.shields.io/cocoapods/p/Alamofire.svg?style=flat)](https://alamofire.github.io/Alamofire)
   7 [![Twitter](https://img.shields.io/badge/twitter-@AlamofireSF-blue.svg?style=flat)](http://twitter.com/AlamofireSF)
   8 [![Gitter](https://badges.gitter.im/Alamofire/Alamofire.svg)](https://gitter.im/Alamofire/Alamofire?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
   9
  10 Alamofire is an HTTP networking library written in Swift.
  11
  12 - [Features](#features)
  13 - [Component Libraries](#component-libraries)
  14 - [Requirements](#requirements)
  15 - [Migration Guides](#migration-guides)
  16 - [Communication](#communication)
  17 - [Installation](#installation)
  18 - [Usage](Documentation/Usage.md)
  19     - **Intro -** [Making a Request](Documentation/Usage.md#making-a-request), [Response Handling](Documentation/Usage.md#response-handling), [Response Validation](Documentation/Usage.md#response-validation), [Response Caching](Documentation/Usage.md#response-caching)
  20         - **HTTP -** [HTTP Methods](Documentation/Usage.md#http-methods), [Parameter Encoding](Documentation/Usage.md#parameter-encoding), [HTTP Headers](Documentation/Usage.md#http-headers), [Authentication](Documentation/Usage.md#authentication)
  21         - **Large Data -** [Downloading Data to a File](Documentation/Usage.md#downloading-data-to-a-file), [Uploading Data to a Server](Documentation/Usage.md#uploading-data-to-a-server)
  22         - **Tools -** [Statistical Metrics](Documentation/Usage.md#statistical-metrics), [cURL Command Output](Documentation/Usage.md#curl-command-output)
  23 - [Advanced Usage](Documentation/AdvancedUsage.md)
  24         - **URL Session -** [Session Manager](Documentation/AdvancedUsage.md#session-manager), [Session Delegate](Documentation/AdvancedUsage.md#session-delegate), [Request](Documentation/AdvancedUsage.md#request)
  25         - **Routing -** [Routing Requests](Documentation/AdvancedUsage.md#routing-requests), [Adapting and Retrying Requests](Documentation/AdvancedUsage.md#adapting-and-retrying-requests)
  26         - **Model Objects -** [Custom Response Serialization](Documentation/AdvancedUsage.md#custom-response-serialization)
  27         - **Connection -** [Security](Documentation/AdvancedUsage.md#security), [Network Reachability](Documentation/AdvancedUsage.md#network-reachability)
  28 - [Open Radars](#open-radars)
  29 - [FAQ](#faq)
  30 - [Credits](#credits)
  31 - [Donations](#donations)
  32 - [License](#license)
  33
  34 ## Features
  35
  36 - [x] Chainable Request / Response Methods
  37 - [x] URL / JSON / plist Parameter Encoding
  38 - [x] Upload File / Data / Stream / MultipartFormData
  39 - [x] Download File using Request or Resume Data
  40 - [x] Authentication with URLCredential
  41 - [x] HTTP Response Validation
  42 - [x] Upload and Download Progress Closures with Progress
  43 - [x] cURL Command Output
  44 - [x] Dynamically Adapt and Retry Requests
  45 - [x] TLS Certificate and Public Key Pinning
  46 - [x] Network Reachability
  47 - [x] Comprehensive Unit and Integration Test Coverage
  48 - [x] [Complete Documentation](https://alamofire.github.io/Alamofire)
  49
  50 ## Component Libraries
  51
  52 In order to keep Alamofire focused specifically on core networking implementations, additional component libraries have been created by the [Alamofire Software Foundation](https://github.com/Alamofire/Foundation) to bring additional functionality to the Alamofire ecosystem.
  53
  54 - [AlamofireImage](https://github.com/Alamofire/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.
  55 - [AlamofireNetworkActivityIndicator](https://github.com/Alamofire/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.
  56
  57 ## Requirements
  58
  59 - iOS 8.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+
  60 - Xcode 8.3+
  61 - Swift 3.1+
  62
  63 ## Migration Guides
  64
  65 - [Alamofire 4.0 Migration Guide](https://github.com/Alamofire/Alamofire/blob/master/Documentation/Alamofire%204.0%20Migration%20Guide.md)
  66 - [Alamofire 3.0 Migration Guide](https://github.com/Alamofire/Alamofire/blob/master/Documentation/Alamofire%203.0%20Migration%20Guide.md)
  67 - [Alamofire 2.0 Migration Guide](https://github.com/Alamofire/Alamofire/blob/master/Documentation/Alamofire%202.0%20Migration%20Guide.md)
  68
  69 ## Communication
  70
  71 - If you **need help**, use [Stack Overflow](http://stackoverflow.com/questions/tagged/alamofire). (Tag 'alamofire')
  72 - If you'd like to **ask a general question**, use [Stack Overflow](http://stackoverflow.com/questions/tagged/alamofire).
  73 - If you **found a bug**, open an issue.
  74 - If you **have a feature request**, open an issue.
  75 - If you **want to contribute**, submit a pull request.
  76
  77 ## Installation
  78
  79 ### CocoaPods
  80
  81 [CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
  82
  83 ```bash
  84 $ gem install cocoapods
  85 ```
  86
  87 > CocoaPods 1.1+ is required to build Alamofire 4.0+.
  88
  89 To integrate Alamofire into your Xcode project using CocoaPods, specify it in your `Podfile`:
  90
  91 ```ruby
  92 source 'https://github.com/CocoaPods/Specs.git'
  93 platform :ios, '10.0'
  94 use_frameworks!
  95
  96 target '<Your Target Name>' do
  97     pod 'Alamofire', '~> 4.5'
  98 end
  99 ```
 100
 101 Then, run the following command:
 102
 103 ```bash
 104 $ pod install
 105 ```
 106
 107 ### Carthage
 108
 109 [Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
 110
 111 You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
 112
 113 ```bash
 114 $ brew update
 115 $ brew install carthage
 116 ```
 117
 118 To integrate Alamofire into your Xcode project using Carthage, specify it in your `Cartfile`:
 119
 120 ```ogdl
 121 github "Alamofire/Alamofire" ~> 4.5
 122 ```
 123
 124 Run `carthage update` to build the framework and drag the built `Alamofire.framework` into your Xcode project.
 125
 126 ### Swift Package Manager
 127
 128 The [Swift Package Manager](https://swift.org/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.
 129
 130 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`.
 131
 132 #### Swift 3
 133
 134 ```swift
 135 dependencies: [
 136     .Package(url: "https://github.com/Alamofire/Alamofire.git", majorVersion: 4)
 137 ]
 138 ```
 139
 140 #### Swift 4
 141
 142 ```swift
 143 dependencies: [
 144     .package(url: "https://github.com/Alamofire/Alamofire.git", from: "4.0.0")
 145 ]
 146 ```
 147
 148 ### Manually
 149
 150 If you prefer not to use any of the aforementioned dependency managers, you can integrate Alamofire into your project manually.
 151
 152 #### Embedded Framework
 153
 154 - 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:
 155
 156   ```bash
 157   $ git init
 158   ```
 159
 160 - Add Alamofire as a git [submodule](http://git-scm.com/docs/git-submodule) by running the following command:
 161
 162   ```bash
 163   $ git submodule add https://github.com/Alamofire/Alamofire.git
 164   ```
 165
 166 - Open the new `Alamofire` folder, and drag the `Alamofire.xcodeproj` into the Project Navigator of your application's Xcode project.
 167
 168     > 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.
 169
 170 - Select the `Alamofire.xcodeproj` in the Project Navigator and verify the deployment target matches that of your application target.
 171 - 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.
 172 - In the tab bar at the top of that window, open the "General" panel.
 173 - Click on the `+` button under the "Embedded Binaries" section.
 174 - You will see two different `Alamofire.xcodeproj` folders each with two different versions of the `Alamofire.framework` nested inside a `Products` folder.
 175
 176     > It does not matter which `Products` folder you choose from, but it does matter whether you choose the top or bottom `Alamofire.framework`.
 177
 178 - Select the top `Alamofire.framework` for iOS and the bottom one for OS X.
 179
 180     > 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`.
 181
 182 - And that's it!
 183
 184   > 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.
 185
 186 ## Open Radars
 187
 188 The following radars have some effect on the current implementation of Alamofire.
 189
 190 - [`rdar://21349340`](http://www.openradar.me/radar?id=5517037090635776) - Compiler throwing warning due to toll-free bridging issue in test case
 191 - `rdar://26870455` - Background URL Session Configurations do not work in the simulator
 192 - `rdar://26849668` - Some URLProtocol APIs do not properly handle `URLRequest`
 193
 194 ## Resolved Radars
 195
 196 The following radars have been resolved over time after being filed against the Alamofire project.
 197
 198 - [`rdar://26761490`](http://www.openradar.me/radar?id=5010235949318144) - Swift string interpolation causing memory leak with common usage (Resolved on 9/1/17 in Xcode 9 beta 6).
 199
 200 ## FAQ
 201
 202 ### What's the origin of the name Alamofire?
 203
 204 Alamofire is named after the [Alamo Fire flower](https://aggie-horticulture.tamu.edu/wildseed/alamofire.html), a hybrid variant of the Bluebonnet, the official state flower of Texas.
 205
 206 ### What logic belongs in a Router vs. a Request Adapter?
 207
 208 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`.
 209
 210 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`.
 211
 212 ## Credits
 213
 214 Alamofire is owned and maintained by the [Alamofire Software Foundation](http://alamofire.org). You can follow them on Twitter at [@AlamofireSF](https://twitter.com/AlamofireSF) for project updates and releases.
 215
 216 ### Security Disclosure
 217
 218 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.
 219
 220 ## Donations
 221
 222 The [ASF](https://github.com/Alamofire/Foundation#members) 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:
 223
 224 - Pay our legal fees to register as a federal non-profit organization
 225 - Pay our yearly legal fees to keep the non-profit in good status
 226 - Pay for our mail servers to help us stay on top of all questions and security issues
 227 - Potentially fund test servers to make it easier for us to test the edge cases
 228 - Potentially fund developers to work on one of our projects full-time
 229
 230 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.
 231
 232 <a href='https://pledgie.com/campaigns/31474'><img alt='Click here to lend your support to: Alamofire Software Foundation and make a donation at pledgie.com !' src='https://pledgie.com/campaigns/31474.png?skin_name=chrome' border='0' ></a>
 233
 234 ## License
 235
 236 Alamofire is released under the MIT license. [See LICENSE](https://github.com/Alamofire/Alamofire/blob/master/LICENSE) for details.