Alamofire.request(.GET, "https://httpbin.org/get", parameters: ["foo": "bar"])
.responseJSON { response in
print(response.request) // original URL request
@@ -339,7 +339,7 @@
Rather than blocking execution to wait for a response from the server, a callback is specified to handle the response once it’s received. The result of a request is only available inside the scope of a response handler. Any execution contingent on the response or data received from the server must be done within a handler.
-Response Serialization
+Response Serialization
Built-in Response Methods
@@ -350,7 +350,7 @@
responseJSON(options: NSJSONReadingOptions)responsePropertyList(options: NSPropertyListReadOptions)Response Handler
+Response Handler
Alamofire.request(.GET, "https://httpbin.org/get", parameters: ["foo": "bar"])
.response { request, response, data, error in
print(request)
@@ -363,7 +363,7 @@
The response serializer does NOT evaluate any of the response data. It merely forwards on all the information directly from the URL session delegate. We strongly encourage you to leverage the other response serializers taking advantage of Response and Result types.
-Response Data Handler
+Response Data Handler
Alamofire.request(.GET, "https://httpbin.org/get", parameters: ["foo": "bar"])
.responseData { response in
print(response.request)
@@ -371,20 +371,20 @@
print(response.result)
}
-Response String Handler
+Response String Handler
Alamofire.request(.GET, "https://httpbin.org/get")
.responseString { response in
print("Success: \(response.result.isSuccess)")
print("Response String: \(response.result.value)")
}
-Response JSON Handler
+Response JSON Handler
Alamofire.request(.GET, "https://httpbin.org/get")
.responseJSON { response in
debugPrint(response)
}
-Chained Response Handlers
+Chained Response Handlers
Response handlers can even be chained:
Alamofire.request(.GET, "https://httpbin.org/get")
@@ -395,7 +395,7 @@
print("Response JSON: \(response.result.value)")
}
-HTTP Methods
+HTTP Methods
Alamofire.Method lists the HTTP methods defined in RFC 7231 §4.3:
public enum Method: String {
@@ -411,11 +411,11 @@
Alamofire.request(.DELETE, "https://httpbin.org/delete")
Parameters
-GET Request With URL-Encoded Parameters
+GET Request With URL-Encoded Parameters
Alamofire.request(.GET, "https://httpbin.org/get", parameters: ["foo": "bar"])
// https://httpbin.org/get?foo=bar
-POST Request With URL-Encoded Parameters
+POST Request With URL-Encoded Parameters
let parameters = [
"foo": "bar",
"baz": ["a", 1],
@@ -429,7 +429,7 @@
Alamofire.request(.POST, "https://httpbin.org/post", parameters: parameters)
// HTTP body: foo=bar&baz[]=a&baz[]=1&qux[x]=1&qux[y]=2&qux[z]=3
-Parameter Encoding
+Parameter Encoding
Parameters can also be encoded as JSON, Property List, or any custom format, using the ParameterEncoding enum:
enum ParameterEncoding {
@@ -451,7 +451,7 @@
PropertyList: Uses NSPropertyListSerialization to create a plist representation of the parameters object, according to the associated format and write options values, which is set as the body of the request. The Content-Type HTTP header field of an encoded request is set to application/x-plist.Custom: Uses the associated closure value to construct a new request given an existing request and parameters.Manual Parameter Encoding of an NSURLRequest
+Manual Parameter Encoding of an NSURLRequest
let URL = NSURL(string: "https://httpbin.org/get")!
var request = NSMutableURLRequest(URL: URL)
@@ -459,7 +459,7 @@
let encoding = Alamofire.ParameterEncoding.URL
(request, _) = encoding.encode(request, parameters: parameters)
-POST Request with JSON-encoded Parameters
+POST Request with JSON-encoded Parameters
let parameters = [
"foo": [1,2,3],
"bar": [
@@ -470,7 +470,7 @@
Alamofire.request(.POST, "https://httpbin.org/post", parameters: parameters, encoding: .JSON)
// HTTP body: {"foo": [1, 2, 3], "bar": {"baz": "qux"}}
-HTTP Headers
+HTTP Headers
Adding a custom HTTP header to a Request is supported directly in the global request method. This makes it easy to attach HTTP headers to a Request that can be constantly changing.
@@ -500,11 +500,11 @@
Stream
MultipartFormData
-Uploading a File
+Uploading a File
let fileURL = NSBundle.mainBundle().URLForResource("Default", withExtension: "png")
Alamofire.upload(.POST, "https://httpbin.org/post", file: fileURL)
-Uploading with Progress
+Uploading with Progress
Alamofire.upload(.POST, "https://httpbin.org/post", file: fileURL)
.progress { bytesWritten, totalBytesWritten, totalBytesExpectedToWrite in
print(totalBytesWritten)
@@ -519,7 +519,7 @@
debugPrint(response)
}
-Uploading MultipartFormData
+Uploading MultipartFormData
Alamofire.upload(
.POST,
"https://httpbin.org/post",
@@ -547,7 +547,7 @@
Request
Resume Data
-Downloading a File
+Downloading a File
Alamofire.download(.GET, "https://httpbin.org/stream/100") { temporaryURL, response in
let fileManager = NSFileManager.defaultManager()
let directoryURL = fileManager.URLsForDirectory(.DocumentDirectory, inDomains: .UserDomainMask)[0]
@@ -556,11 +556,11 @@
return directoryURL.URLByAppendingPathComponent(pathComponent!)
}
-Using the Default Download Destination
+Using the Default Download Destination
let destination = Alamofire.Request.suggestedDownloadDestination(directory: .DocumentDirectory, domain: .UserDomainMask)
Alamofire.download(.GET, "https://httpbin.org/stream/100", destination: destination)
-Downloading a File w/Progress
+Downloading a File w/Progress
Alamofire.download(.GET, "https://httpbin.org/stream/100", destination: destination)
.progress { bytesRead, totalBytesRead, totalBytesExpectedToRead in
print(totalBytesRead)
@@ -579,7 +579,7 @@
}
}
-Accessing Resume Data for Failed Downloads
+Accessing Resume Data for Failed Downloads
Alamofire.download(.GET, "https://httpbin.org/stream/100", destination: destination)
.response { _, _, data, _ in
if let
@@ -620,7 +620,7 @@
Kerberos
NTLM
-HTTP Basic Authentication
+HTTP Basic Authentication
The authenticate method on a Request will automatically provide an NSURLCredential to an NSURLAuthenticationChallenge when appropriate:
let user = "user"
@@ -647,7 +647,7 @@
debugPrint(response)
}
-Authentication with NSURLCredential
+Authentication with NSURLCredential
let user = "user"
let password = "password"
@@ -662,7 +662,7 @@
Validation
By default, Alamofire treats any completed request to be successful, regardless of the content of the response. Calling validate before a response handler causes an error to be generated if the response had an unacceptable status code or MIME type.
-Manual Validation
+Manual Validation
Alamofire.request(.GET, "https://httpbin.org/get", parameters: ["foo": "bar"])
.validate(statusCode: 200..<300)
.validate(contentType: ["application/json"])
@@ -670,7 +670,7 @@
print(response)
}
-Automatic Validation
+Automatic Validation
Automatically validates status code within 200...299 range, and that the Content-Type header of the response matches the Accept header of the request, if one is provided.
Alamofire.request(.GET, "https://httpbin.org/get", parameters: ["foo": "bar"])
@@ -713,7 +713,7 @@
debugPrint(request)
-Output (cURL)
+Output (cURL)
$ curl -i \
-H "User-Agent: Alamofire" \
-H "Accept-Encoding: Accept-Encoding: gzip;q=1.0,compress;q=0.5" \
@@ -722,7 +722,7 @@
-Advanced Usage
+Advanced Usage
Alamofire is built on NSURLSession and the Foundation URL Loading System. To make the most of
@@ -749,19 +749,19 @@
Applications can create managers for background and ephemeral sessions, as well as new managers that customize the default session configuration, such as for default headers (HTTPAdditionalHeaders) or timeout interval (timeoutIntervalForRequest).
-Creating a Manager with Default Configuration
+Creating a Manager with Default Configuration
let configuration = NSURLSessionConfiguration.defaultSessionConfiguration()
let manager = Alamofire.Manager(configuration: configuration)
-Creating a Manager with Background Configuration
+Creating a Manager with Background Configuration
let configuration = NSURLSessionConfiguration.backgroundSessionConfigurationWithIdentifier("com.example.app.background")
let manager = Alamofire.Manager(configuration: configuration)
-Creating a Manager with Ephemeral Configuration
+Creating a Manager with Ephemeral Configuration
let configuration = NSURLSessionConfiguration.ephemeralSessionConfiguration()
let manager = Alamofire.Manager(configuration: configuration)
-Modifying Session Configuration
+Modifying Session Configuration
var defaultHeaders = Alamofire.Manager.sharedInstance.session.configuration.HTTPAdditionalHeaders ?? [:]
defaultHeaders["DNT"] = "1 (Do Not Track Enabled)"
@@ -787,8 +787,8 @@
resume(): Resumes the underlying task and dispatch queue. If the owning manager does not have startRequestsImmediately set to true, the request must call resume() in order to start.cancel(): Cancels the underlying task, producing an error that is passed to any registered response handlers.Response Serialization
-Creating a Custom Response Serializer
+Response Serialization
+Creating a Custom Response Serializer
Alamofire provides built-in response serialization for strings, JSON, and property lists, but others can be added in extensions on Alamofire.Request.
@@ -818,7 +818,7 @@
}
}
-Generic Response Object Serialization
+Generic Response Object Serialization
Generics can be used to provide automatic, type-safe response object serialization.
public protocol ResponseObjectSerializable {
@@ -947,7 +947,7 @@
Applications interacting with web applications in a significant manner are encouraged to have custom types conform to URLStringConvertible as a convenient way to map domain-specific models to server resources.
-Type-Safe Routing
+Type-Safe Routing
extension User: URLStringConvertible {
static let baseURLString = "http://example.com"
@@ -980,7 +980,7 @@
Applications interacting with web applications in a significant manner are encouraged to have custom types conform to URLRequestConvertible as a way to ensure consistency of requested endpoints. Such an approach can be used to abstract away server-side inconsistencies and provide type-safe routing, as well as manage authentication credentials and other state.
-API Parameter Abstraction
+API Parameter Abstraction
enum Router: URLRequestConvertible {
static let baseURLString = "http://example.com"
static let perPage = 50
@@ -1009,7 +1009,7 @@
Alamofire.request(Router.Search(query: "foo bar", page: 1)) // ?q=foo%20bar&offset=50
-CRUD & Authorization
+CRUD & Authorization
enum Router: URLRequestConvertible {
static let baseURLString = "http://example.com"
static var OAuthToken: String?
@@ -1091,7 +1091,7 @@
DisableEvaluation: Disables all evaluation which in turn will always consider any server trust as valid.CustomEvaluation: Uses the associated closure to evaluate the validity of the server trust thus giving you complete control over the validation process. Use with caution.Server Trust Policy Manager
+Server Trust Policy Manager
The ServerTrustPolicyManager is responsible for storing an internal mapping of server trust policies to a particular host. This allows Alamofire to evaluate each host against a different server trust policy.
let serverTrustPolicies: [String: ServerTrustPolicy] = [
@@ -1125,7 +1125,7 @@
insecure.expired-apis.com will never evaluate the certificate chain and will always allow the TLS handshake to succeed.All other hosts will use the default evaluation provided by Apple.
-Subclassing Server Trust Policy Manager
+Subclassing Server Trust Policy Manager
If you find yourself needing more flexible server trust policy matching behavior (i.e. wildcarded domains), then subclass the ServerTrustPolicyManager and override the serverTrustPolicyForHost method with your own custom implementation.
class CustomServerTrustPolicyManager: ServerTrustPolicyManager {
@@ -1138,14 +1138,14 @@
}
}
-Validating the Host
+Validating the Host
The .PerformDefaultEvaluation, .PinCertificates and .PinPublicKeys server trust policies all take a validateHost parameter. Setting the value to true will cause the server trust evaluation to verify that hostname in the certificate matches the hostname of the challenge. If they do not match, evaluation will fail. A validateHost value of false will still evaluate the full certificate chain, but will not validate the hostname of the leaf certificate.
It is recommended that validateHost always be set to true in production environments.
-Validating the Certificate Chain
+Validating the Certificate Chain
Pinning certificates and public keys both have the option of validating the certificate chain using the validateCertificateChain parameter. By setting this value to true, the full certificate chain will be evaluated in addition to performing a byte equality check against the pinned certficates or public keys. A value of false will skip the certificate chain validation, but will still perform the byte equality check.
@@ -1154,7 +1154,7 @@
It is recommended that validateCertificateChain always be set to true in production environments.
-App Transport Security
+App Transport Security
With the addition of App Transport Security (ATS) in iOS 9, it is possible that using a custom ServerTrustPolicyManager with several ServerTrustPolicy objects will have no effect. If you continuously see CFNetwork SSLHandshake failed (-9806) errors, you have probably run into this problem. Apple’s ATS system overrides the entire challenge system unless you configure the ATS settings in your app’s plist to disable enough of it to allow your app to evaluate the server trust.
@@ -1186,7 +1186,7 @@
It is recommended to always use valid certificates in production environments.
-Network Reachability
+Network Reachability
The NetworkReachabilityManager listens for reachability changes of hosts and addresses for both WWAN and WiFi network interfaces.
let manager = NetworkReachabilityManager(host: "www.apple.com")
@@ -1227,7 +1227,7 @@
-Open Rdars
+Open Rdars
The following rdars have some affect on the current implementation of Alamofire.
@@ -1235,7 +1235,7 @@
rdar://21349340 - Compiler throwing warning due to toll-free bridging issue in test case
FAQ
-What’s the origin of the name Alamofire?
+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.
@@ -1243,7 +1243,7 @@
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
+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.
License
diff --git a/document_alamofire/after/docs/index.html b/document_alamofire/after/docs/index.html
index bd07d2e65..263e056f5 100644
--- a/document_alamofire/after/docs/index.html
+++ b/document_alamofire/after/docs/index.html
@@ -198,7 +198,7 @@
[x] Comprehensive Unit Test Coverage
[x] Complete Documentation
-Component Libraries
+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.
@@ -212,7 +212,7 @@
iOS 8.0+ / Mac OS X 10.9+ / tvOS 9.0+ / watchOS 2.0+
Xcode 7.2+
-Migration Guides
+Migration Guides
- Alamofire 3.0 Migration Guide
@@ -272,7 +272,7 @@
Manually
If you prefer not to use either of the aforementioned dependency managers, you can integrate Alamofire into your project manually.
-Embedded Framework
+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:
@@ -315,12 +315,12 @@
Usage
-Making a Request
+Making a Request
import Alamofire
Alamofire.request(.GET, "https://httpbin.org/get")
-Response Handling
+Response Handling
Alamofire.request(.GET, "https://httpbin.org/get", parameters: ["foo": "bar"])
.responseJSON { response in
print(response.request) // original URL request
@@ -339,7 +339,7 @@
Rather than blocking execution to wait for a response from the server, a callback is specified to handle the response once it’s received. The result of a request is only available inside the scope of a response handler. Any execution contingent on the response or data received from the server must be done within a handler.
-Response Serialization
+Response Serialization
Built-in Response Methods
@@ -350,7 +350,7 @@
responseJSON(options: NSJSONReadingOptions)responsePropertyList(options: NSPropertyListReadOptions)Response Handler
+Response Handler
Alamofire.request(.GET, "https://httpbin.org/get", parameters: ["foo": "bar"])
.response { request, response, data, error in
print(request)
@@ -363,7 +363,7 @@
The response serializer does NOT evaluate any of the response data. It merely forwards on all the information directly from the URL session delegate. We strongly encourage you to leverage the other response serializers taking advantage of Response and Result types.
-Response Data Handler
+Response Data Handler
Alamofire.request(.GET, "https://httpbin.org/get", parameters: ["foo": "bar"])
.responseData { response in
print(response.request)
@@ -371,20 +371,20 @@
print(response.result)
}
-Response String Handler
+Response String Handler
Alamofire.request(.GET, "https://httpbin.org/get")
.responseString { response in
print("Success: \(response.result.isSuccess)")
print("Response String: \(response.result.value)")
}
-Response JSON Handler
+Response JSON Handler
Alamofire.request(.GET, "https://httpbin.org/get")
.responseJSON { response in
debugPrint(response)
}
-Chained Response Handlers
+Chained Response Handlers
Response handlers can even be chained:
Alamofire.request(.GET, "https://httpbin.org/get")
@@ -395,7 +395,7 @@
print("Response JSON: \(response.result.value)")
}
-HTTP Methods
+HTTP Methods
Alamofire.Method lists the HTTP methods defined in RFC 7231 §4.3:
public enum Method: String {
@@ -411,11 +411,11 @@
Alamofire.request(.DELETE, "https://httpbin.org/delete")
Parameters
-GET Request With URL-Encoded Parameters
+GET Request With URL-Encoded Parameters
Alamofire.request(.GET, "https://httpbin.org/get", parameters: ["foo": "bar"])
// https://httpbin.org/get?foo=bar
-POST Request With URL-Encoded Parameters
+POST Request With URL-Encoded Parameters
let parameters = [
"foo": "bar",
"baz": ["a", 1],
@@ -429,7 +429,7 @@
Alamofire.request(.POST, "https://httpbin.org/post", parameters: parameters)
// HTTP body: foo=bar&baz[]=a&baz[]=1&qux[x]=1&qux[y]=2&qux[z]=3
-Parameter Encoding
+Parameter Encoding
Parameters can also be encoded as JSON, Property List, or any custom format, using the ParameterEncoding enum:
enum ParameterEncoding {
@@ -451,7 +451,7 @@
PropertyList: Uses NSPropertyListSerialization to create a plist representation of the parameters object, according to the associated format and write options values, which is set as the body of the request. The Content-Type HTTP header field of an encoded request is set to application/x-plist.Custom: Uses the associated closure value to construct a new request given an existing request and parameters.Manual Parameter Encoding of an NSURLRequest
+Manual Parameter Encoding of an NSURLRequest
let URL = NSURL(string: "https://httpbin.org/get")!
var request = NSMutableURLRequest(URL: URL)
@@ -459,7 +459,7 @@
let encoding = Alamofire.ParameterEncoding.URL
(request, _) = encoding.encode(request, parameters: parameters)
-POST Request with JSON-encoded Parameters
+POST Request with JSON-encoded Parameters
let parameters = [
"foo": [1,2,3],
"bar": [
@@ -470,7 +470,7 @@
Alamofire.request(.POST, "https://httpbin.org/post", parameters: parameters, encoding: .JSON)
// HTTP body: {"foo": [1, 2, 3], "bar": {"baz": "qux"}}
-HTTP Headers
+HTTP Headers
Adding a custom HTTP header to a Request is supported directly in the global request method. This makes it easy to attach HTTP headers to a Request that can be constantly changing.
@@ -500,11 +500,11 @@
Stream
MultipartFormData
-Uploading a File
+Uploading a File
let fileURL = NSBundle.mainBundle().URLForResource("Default", withExtension: "png")
Alamofire.upload(.POST, "https://httpbin.org/post", file: fileURL)
-Uploading with Progress
+Uploading with Progress
Alamofire.upload(.POST, "https://httpbin.org/post", file: fileURL)
.progress { bytesWritten, totalBytesWritten, totalBytesExpectedToWrite in
print(totalBytesWritten)
@@ -519,7 +519,7 @@
debugPrint(response)
}
-Uploading MultipartFormData
+Uploading MultipartFormData
Alamofire.upload(
.POST,
"https://httpbin.org/post",
@@ -547,7 +547,7 @@
Request
Resume Data
-Downloading a File
+Downloading a File
Alamofire.download(.GET, "https://httpbin.org/stream/100") { temporaryURL, response in
let fileManager = NSFileManager.defaultManager()
let directoryURL = fileManager.URLsForDirectory(.DocumentDirectory, inDomains: .UserDomainMask)[0]
@@ -556,11 +556,11 @@
return directoryURL.URLByAppendingPathComponent(pathComponent!)
}
-Using the Default Download Destination
+Using the Default Download Destination
let destination = Alamofire.Request.suggestedDownloadDestination(directory: .DocumentDirectory, domain: .UserDomainMask)
Alamofire.download(.GET, "https://httpbin.org/stream/100", destination: destination)
-Downloading a File w/Progress
+Downloading a File w/Progress
Alamofire.download(.GET, "https://httpbin.org/stream/100", destination: destination)
.progress { bytesRead, totalBytesRead, totalBytesExpectedToRead in
print(totalBytesRead)
@@ -579,7 +579,7 @@
}
}
-Accessing Resume Data for Failed Downloads
+Accessing Resume Data for Failed Downloads
Alamofire.download(.GET, "https://httpbin.org/stream/100", destination: destination)
.response { _, _, data, _ in
if let
@@ -620,7 +620,7 @@
Kerberos
NTLM
-HTTP Basic Authentication
+HTTP Basic Authentication
The authenticate method on a Request will automatically provide an NSURLCredential to an NSURLAuthenticationChallenge when appropriate:
let user = "user"
@@ -647,7 +647,7 @@
debugPrint(response)
}
-Authentication with NSURLCredential
+Authentication with NSURLCredential
let user = "user"
let password = "password"
@@ -662,7 +662,7 @@
Validation
By default, Alamofire treats any completed request to be successful, regardless of the content of the response. Calling validate before a response handler causes an error to be generated if the response had an unacceptable status code or MIME type.
-Manual Validation
+Manual Validation
Alamofire.request(.GET, "https://httpbin.org/get", parameters: ["foo": "bar"])
.validate(statusCode: 200..<300)
.validate(contentType: ["application/json"])
@@ -670,7 +670,7 @@
print(response)
}
-Automatic Validation
+Automatic Validation
Automatically validates status code within 200...299 range, and that the Content-Type header of the response matches the Accept header of the request, if one is provided.
Alamofire.request(.GET, "https://httpbin.org/get", parameters: ["foo": "bar"])
@@ -713,7 +713,7 @@
debugPrint(request)
-Output (cURL)
+Output (cURL)
$ curl -i \
-H "User-Agent: Alamofire" \
-H "Accept-Encoding: Accept-Encoding: gzip;q=1.0,compress;q=0.5" \
@@ -722,7 +722,7 @@
-Advanced Usage
+Advanced Usage
Alamofire is built on NSURLSession and the Foundation URL Loading System. To make the most of
@@ -749,19 +749,19 @@
Applications can create managers for background and ephemeral sessions, as well as new managers that customize the default session configuration, such as for default headers (HTTPAdditionalHeaders) or timeout interval (timeoutIntervalForRequest).
-Creating a Manager with Default Configuration
+Creating a Manager with Default Configuration
let configuration = NSURLSessionConfiguration.defaultSessionConfiguration()
let manager = Alamofire.Manager(configuration: configuration)
-Creating a Manager with Background Configuration
+Creating a Manager with Background Configuration
let configuration = NSURLSessionConfiguration.backgroundSessionConfigurationWithIdentifier("com.example.app.background")
let manager = Alamofire.Manager(configuration: configuration)
-Creating a Manager with Ephemeral Configuration
+Creating a Manager with Ephemeral Configuration
let configuration = NSURLSessionConfiguration.ephemeralSessionConfiguration()
let manager = Alamofire.Manager(configuration: configuration)
-Modifying Session Configuration
+Modifying Session Configuration
var defaultHeaders = Alamofire.Manager.sharedInstance.session.configuration.HTTPAdditionalHeaders ?? [:]
defaultHeaders["DNT"] = "1 (Do Not Track Enabled)"
@@ -787,8 +787,8 @@
resume(): Resumes the underlying task and dispatch queue. If the owning manager does not have startRequestsImmediately set to true, the request must call resume() in order to start.cancel(): Cancels the underlying task, producing an error that is passed to any registered response handlers.Response Serialization
-Creating a Custom Response Serializer
+Response Serialization
+Creating a Custom Response Serializer
Alamofire provides built-in response serialization for strings, JSON, and property lists, but others can be added in extensions on Alamofire.Request.
@@ -818,7 +818,7 @@
}
}
-Generic Response Object Serialization
+Generic Response Object Serialization
Generics can be used to provide automatic, type-safe response object serialization.
public protocol ResponseObjectSerializable {
@@ -947,7 +947,7 @@
Applications interacting with web applications in a significant manner are encouraged to have custom types conform to URLStringConvertible as a convenient way to map domain-specific models to server resources.
-Type-Safe Routing
+Type-Safe Routing
extension User: URLStringConvertible {
static let baseURLString = "http://example.com"
@@ -980,7 +980,7 @@
Applications interacting with web applications in a significant manner are encouraged to have custom types conform to URLRequestConvertible as a way to ensure consistency of requested endpoints. Such an approach can be used to abstract away server-side inconsistencies and provide type-safe routing, as well as manage authentication credentials and other state.
-API Parameter Abstraction
+API Parameter Abstraction
enum Router: URLRequestConvertible {
static let baseURLString = "http://example.com"
static let perPage = 50
@@ -1009,7 +1009,7 @@
Alamofire.request(Router.Search(query: "foo bar", page: 1)) // ?q=foo%20bar&offset=50
-CRUD & Authorization
+CRUD & Authorization
enum Router: URLRequestConvertible {
static let baseURLString = "http://example.com"
static var OAuthToken: String?
@@ -1091,7 +1091,7 @@
DisableEvaluation: Disables all evaluation which in turn will always consider any server trust as valid.CustomEvaluation: Uses the associated closure to evaluate the validity of the server trust thus giving you complete control over the validation process. Use with caution.Server Trust Policy Manager
+Server Trust Policy Manager
The ServerTrustPolicyManager is responsible for storing an internal mapping of server trust policies to a particular host. This allows Alamofire to evaluate each host against a different server trust policy.
let serverTrustPolicies: [String: ServerTrustPolicy] = [
@@ -1125,7 +1125,7 @@
insecure.expired-apis.com will never evaluate the certificate chain and will always allow the TLS handshake to succeed.All other hosts will use the default evaluation provided by Apple.
-Subclassing Server Trust Policy Manager
+Subclassing Server Trust Policy Manager
If you find yourself needing more flexible server trust policy matching behavior (i.e. wildcarded domains), then subclass the ServerTrustPolicyManager and override the serverTrustPolicyForHost method with your own custom implementation.
class CustomServerTrustPolicyManager: ServerTrustPolicyManager {
@@ -1138,14 +1138,14 @@
}
}
-Validating the Host
+Validating the Host
The .PerformDefaultEvaluation, .PinCertificates and .PinPublicKeys server trust policies all take a validateHost parameter. Setting the value to true will cause the server trust evaluation to verify that hostname in the certificate matches the hostname of the challenge. If they do not match, evaluation will fail. A validateHost value of false will still evaluate the full certificate chain, but will not validate the hostname of the leaf certificate.
It is recommended that validateHost always be set to true in production environments.
-Validating the Certificate Chain
+Validating the Certificate Chain
Pinning certificates and public keys both have the option of validating the certificate chain using the validateCertificateChain parameter. By setting this value to true, the full certificate chain will be evaluated in addition to performing a byte equality check against the pinned certficates or public keys. A value of false will skip the certificate chain validation, but will still perform the byte equality check.
@@ -1154,7 +1154,7 @@
It is recommended that validateCertificateChain always be set to true in production environments.
-App Transport Security
+App Transport Security
With the addition of App Transport Security (ATS) in iOS 9, it is possible that using a custom ServerTrustPolicyManager with several ServerTrustPolicy objects will have no effect. If you continuously see CFNetwork SSLHandshake failed (-9806) errors, you have probably run into this problem. Apple’s ATS system overrides the entire challenge system unless you configure the ATS settings in your app’s plist to disable enough of it to allow your app to evaluate the server trust.
@@ -1186,7 +1186,7 @@
It is recommended to always use valid certificates in production environments.
-Network Reachability
+Network Reachability
The NetworkReachabilityManager listens for reachability changes of hosts and addresses for both WWAN and WiFi network interfaces.
let manager = NetworkReachabilityManager(host: "www.apple.com")
@@ -1227,7 +1227,7 @@
-Open Rdars
+Open Rdars
The following rdars have some affect on the current implementation of Alamofire.
@@ -1235,7 +1235,7 @@
rdar://21349340 - Compiler throwing warning due to toll-free bridging issue in test case
FAQ
-What’s the origin of the name Alamofire?
+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.
@@ -1243,7 +1243,7 @@
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
+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.
License
diff --git a/document_moya_podspec/after/docs/docsets/Moya.docset/Contents/Resources/Documents/index.html b/document_moya_podspec/after/docs/docsets/Moya.docset/Contents/Resources/Documents/index.html
index df5c530e3..d5f159dfb 100644
--- a/document_moya_podspec/after/docs/docsets/Moya.docset/Contents/Resources/Documents/index.html
+++ b/document_moya_podspec/after/docs/docsets/Moya.docset/Contents/Resources/Documents/index.html
@@ -191,10 +191,10 @@
Lets you define a clear usage of different endpoints with associated enum values.
Treats test stubs as first-class citizens so unit testing is super-easy.
-Sample Project
+Sample Project
There’s a sample project in the Demo directory. Have fun!
-Project Status
+Project Status
This project is actively under development, and is being used in Artsy’s
new auction app. We consider it
@@ -254,7 +254,7 @@
parameter encoding.
For examples, see the documentation.
-Reactive Extensions
+Reactive Extensions
Even cooler are the reactive extensions. Moya provides reactive extensions for
ReactiveCocoa and RxSwift.
@@ -300,7 +300,7 @@
for filtering out certain status codes. This means that you can place your code for
handling API errors like 400’s in the same places as code for handling invalid
responses.
-Community Extensions
+Community Extensions
Moya has a great community around it and some people have created some very helpful extensions.
diff --git a/document_moya_podspec/after/docs/index.html b/document_moya_podspec/after/docs/index.html
index df5c530e3..d5f159dfb 100644
--- a/document_moya_podspec/after/docs/index.html
+++ b/document_moya_podspec/after/docs/index.html
@@ -191,10 +191,10 @@
Lets you define a clear usage of different endpoints with associated enum values.
Treats test stubs as first-class citizens so unit testing is super-easy.
-Sample Project
+Sample Project
There’s a sample project in the Demo directory. Have fun!
-Project Status
+Project Status
This project is actively under development, and is being used in Artsy’s
new auction app. We consider it
@@ -254,7 +254,7 @@
parameter encoding.
For examples, see the documentation.
-Reactive Extensions
+Reactive Extensions
Even cooler are the reactive extensions. Moya provides reactive extensions for
ReactiveCocoa and RxSwift.
@@ -300,7 +300,7 @@
for filtering out certain status codes. This means that you can place your code for
handling API errors like 400’s in the same places as code for handling invalid
responses.
-Community Extensions
+Community Extensions
Moya has a great community around it and some people have created some very helpful extensions.
diff --git a/document_realm_objc/after/docs/Classes.html b/document_realm_objc/after/docs/Classes.html
index 5fabfaf20..9df1da715 100644
--- a/document_realm_objc/after/docs/Classes.html
+++ b/document_realm_objc/after/docs/Classes.html
@@ -190,7 +190,7 @@ Classes
RLMArrays cannot be created directly. RLMArray properties on RLMObjects are
lazily created when accessed, or can be obtained by querying a Realm.
-
Key-Value Observing
+
Key-Value Observing
RLMArray supports array key-value observing on RLMArray properties on RLMObject
subclasses, and the invalidated property on RLMArray instances themselves is
@@ -321,7 +321,7 @@
Declaration
@end //none needed
-
Supported property types
+
Supported property types
NSStringDeclaration
See our Cocoa guide for more details.
-
Key-Value Observing
+
Key-Value Observing
All RLMObject properties (including properties you create in subclasses) are
Key-Value Observing compliant,
diff --git a/document_realm_objc/after/docs/Classes/RLMArray.html b/document_realm_objc/after/docs/Classes/RLMArray.html
index 5b940e333..fd16abba0 100644
--- a/document_realm_objc/after/docs/Classes/RLMArray.html
+++ b/document_realm_objc/after/docs/Classes/RLMArray.html
@@ -178,7 +178,7 @@
RLMArray
RLMArrays cannot be created directly. RLMArray properties on RLMObjects are
lazily created when accessed, or can be obtained by querying a Realm.
-
Key-Value Observing
+
Key-Value Observing
RLMArray supports array key-value observing on RLMArray properties on RLMObject
subclasses, and the invalidated property on RLMArray instances themselves is
diff --git a/document_realm_objc/after/docs/Classes/RLMObject.html b/document_realm_objc/after/docs/Classes/RLMObject.html
index 9d8c9235c..23c6204ac 100644
--- a/document_realm_objc/after/docs/Classes/RLMObject.html
+++ b/document_realm_objc/after/docs/Classes/RLMObject.html
@@ -172,7 +172,7 @@
RLMObject
@end //none needed
-
Supported property types
+
Supported property types
NSStringRLMObject
See our Cocoa guide for more details.
-
Key-Value Observing
+
Key-Value Observing
All RLMObject properties (including properties you create in subclasses) are
Key-Value Observing compliant,
diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes.html
index 5fabfaf20..9df1da715 100644
--- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes.html
+++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes.html
@@ -190,7 +190,7 @@
Classes
RLMArrays cannot be created directly. RLMArray properties on RLMObjects are
lazily created when accessed, or can be obtained by querying a Realm.
-
Key-Value Observing
+
Key-Value Observing
RLMArray supports array key-value observing on RLMArray properties on RLMObject
subclasses, and the invalidated property on RLMArray instances themselves is
@@ -321,7 +321,7 @@
Declaration
@end //none needed
-
Supported property types
+
Supported property types
NSStringDeclaration
See our Cocoa guide for more details.
-
Key-Value Observing
+
Key-Value Observing
All RLMObject properties (including properties you create in subclasses) are
Key-Value Observing compliant,
diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMArray.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMArray.html
index 5b940e333..fd16abba0 100644
--- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMArray.html
+++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMArray.html
@@ -178,7 +178,7 @@
RLMArray
RLMArrays cannot be created directly. RLMArray properties on RLMObjects are
lazily created when accessed, or can be obtained by querying a Realm.
-
Key-Value Observing
+
Key-Value Observing
RLMArray supports array key-value observing on RLMArray properties on RLMObject
subclasses, and the invalidated property on RLMArray instances themselves is
diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMObject.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMObject.html
index 9d8c9235c..23c6204ac 100644
--- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMObject.html
+++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMObject.html
@@ -172,7 +172,7 @@
RLMObject
@end //none needed
-
Supported property types
+
Supported property types
NSStringRLMObject
See our Cocoa guide for more details.
-
Key-Value Observing
+
Key-Value Observing
All RLMObject properties (including properties you create in subclasses) are
Key-Value Observing compliant,
diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/index.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/index.html
index 86664cb7e..fb84d4ebd 100644
--- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/index.html
+++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/index.html
@@ -163,19 +163,19 @@
- Modern: Realm supports relationships, generics, vectorization and even Swift.
- Fast: Realm is faster than even raw SQLite on common operations, while maintaining an extremely rich feature set.
-Getting Started
+Getting Started
Please see the detailed instructions in our docs to add Realm Objective-C or Realm Swift to your Xcode project.
Documentation
-Realm Objective-C
+Realm Objective-C
The documentation can be found at realm.io/docs/objc/latest.
The API reference is located at realm.io/docs/objc/latest/api.
-Realm Swift
+Realm Swift
The documentation can be found at realm.io/docs/swift/latest.
The API reference is located at realm.io/docs/swift/latest/api.
-Getting Help
+Getting Help
- Need help with your code?: Look for previous questions on the #realm tag — or ask a new question. We activtely monitor & answer questions on SO!
@@ -183,7 +183,7 @@
- Have a feature request? Open an issue. Tell us what the feature should do, and why you want the feature.
- Sign up for our Community Newsletter to get regular tips, learn about other use-cases and get alerted of blogposts and tutorials about Realm.
-Building Realm
+Building Realm
In case you don’t want to use the precompiled version, you can build Realm yourself from source.
diff --git a/document_realm_objc/after/docs/index.html b/document_realm_objc/after/docs/index.html
index 86664cb7e..fb84d4ebd 100644
--- a/document_realm_objc/after/docs/index.html
+++ b/document_realm_objc/after/docs/index.html
@@ -163,19 +163,19 @@
Modern: Realm supports relationships, generics, vectorization and even Swift.
Fast: Realm is faster than even raw SQLite on common operations, while maintaining an extremely rich feature set.
-Getting Started
+Getting Started
Please see the detailed instructions in our docs to add Realm Objective-C or Realm Swift to your Xcode project.
Documentation
-Realm Objective-C
+Realm Objective-C
The documentation can be found at realm.io/docs/objc/latest.
The API reference is located at realm.io/docs/objc/latest/api.
-Realm Swift
+Realm Swift
The documentation can be found at realm.io/docs/swift/latest.
The API reference is located at realm.io/docs/swift/latest/api.
-Getting Help
+Getting Help
- Need help with your code?: Look for previous questions on the #realm tag — or ask a new question. We activtely monitor & answer questions on SO!
@@ -183,7 +183,7 @@
- Have a feature request? Open an issue. Tell us what the feature should do, and why you want the feature.
- Sign up for our Community Newsletter to get regular tips, learn about other use-cases and get alerted of blogposts and tutorials about Realm.
-Building Realm
+Building Realm
In case you don’t want to use the precompiled version, you can build Realm yourself from source.
diff --git a/document_realm_swift/after/docs/Classes.html b/document_realm_swift/after/docs/Classes.html
index 23b8c837a..494224c98 100644
--- a/document_realm_swift/after/docs/Classes.html
+++ b/document_realm_swift/after/docs/Classes.html
@@ -288,7 +288,7 @@ Declaration
}
-
Supported property types
+
Supported property types
String, NSStringObject
}
-
Supported property types
+
Supported property types
String, NSStringDeclaration
See Realm Models.
-
Primitive types
+
Primitive types
- Int
@@ -249,7 +249,7 @@ Declaration
- Double
-
Object types
+
Object types
- String
- Data
@@ -257,7 +257,7 @@ Declaration
Date
-Relationships: List (Array) and Object types
+Relationships: List (Array) and Object types
- Object
diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes.html
index 23b8c837a..494224c98 100644
--- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes.html
+++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes.html
@@ -288,7 +288,7 @@ Declaration
}
-
Supported property types
+
Supported property types
String, NSStringObject
}
-
Supported property types
+
Supported property types
String, NSStringDeclaration
See Realm Models.
-
Primitive types
+
Primitive types
- Int
@@ -249,7 +249,7 @@ Declaration
- Double
-
Object types
+
Object types
- String
- Data
@@ -257,7 +257,7 @@ Declaration
Date
-Relationships: List (Array) and Object types
+Relationships: List (Array) and Object types
- Object
diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/index.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/index.html
index 5f05ea4be..54c21918a 100644
--- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/index.html
+++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/index.html
@@ -192,19 +192,19 @@
- Modern: Realm supports relationships, generics, vectorization and even Swift.
- Fast: Realm is faster than even raw SQLite on common operations, while maintaining an extremely rich feature set.
-Getting Started
+Getting Started
Please see the detailed instructions in our docs to add Realm Objective-C or Realm Swift to your Xcode project.
Documentation
-Realm Objective-C
+Realm Objective-C
The documentation can be found at realm.io/docs/objc/latest.
The API reference is located at realm.io/docs/objc/latest/api.
-Realm Swift
+Realm Swift
The documentation can be found at realm.io/docs/swift/latest.
The API reference is located at realm.io/docs/swift/latest/api.
-Getting Help
+Getting Help
- Need help with your code?: Look for previous questions on the #realm tag — or ask a new question. We activtely monitor & answer questions on SO!
@@ -212,7 +212,7 @@
- Have a feature request? Open an issue. Tell us what the feature should do, and why you want the feature.
- Sign up for our Community Newsletter to get regular tips, learn about other use-cases and get alerted of blogposts and tutorials about Realm.
-Building Realm
+Building Realm
In case you don’t want to use the precompiled version, you can build Realm yourself from source.
diff --git a/document_realm_swift/after/docs/index.html b/document_realm_swift/after/docs/index.html
index 5f05ea4be..54c21918a 100644
--- a/document_realm_swift/after/docs/index.html
+++ b/document_realm_swift/after/docs/index.html
@@ -192,19 +192,19 @@
- Modern: Realm supports relationships, generics, vectorization and even Swift.
- Fast: Realm is faster than even raw SQLite on common operations, while maintaining an extremely rich feature set.
-Getting Started
+Getting Started
Please see the detailed instructions in our docs to add Realm Objective-C or Realm Swift to your Xcode project.
Documentation
-Realm Objective-C
+Realm Objective-C
The documentation can be found at realm.io/docs/objc/latest.
The API reference is located at realm.io/docs/objc/latest/api.
-Realm Swift
+Realm Swift
The documentation can be found at realm.io/docs/swift/latest.
The API reference is located at realm.io/docs/swift/latest/api.
-Getting Help
+Getting Help
- Need help with your code?: Look for previous questions on the #realm tag — or ask a new question. We activtely monitor & answer questions on SO!
@@ -212,7 +212,7 @@
- Have a feature request? Open an issue. Tell us what the feature should do, and why you want the feature.
- Sign up for our Community Newsletter to get regular tips, learn about other use-cases and get alerted of blogposts and tutorials about Realm.
-Building Realm
+Building Realm
In case you don’t want to use the precompiled version, you can build Realm yourself from source.
diff --git a/document_siesta/after/api-docs/docsets/Siesta.docset/Contents/Resources/Documents/index.html b/document_siesta/after/api-docs/docsets/Siesta.docset/Contents/Resources/Documents/index.html
index 5f136915f..f264de1b2 100644
--- a/document_siesta/after/api-docs/docsets/Siesta.docset/Contents/Resources/Documents/index.html
+++ b/document_siesta/after/api-docs/docsets/Siesta.docset/Contents/Resources/Documents/index.html
@@ -197,7 +197,7 @@
- 
+
iOS REST Client Framework
@@ -236,8 +236,8 @@
Examples
Contributing and Getting Help
-What’s It For?
-The Problem
+What’s It For?
+The Problem
Want your app to talk to a remote API? Welcome to your state nightmare!
@@ -250,7 +250,7 @@
Naturally you’ll want to rewrite all of this from scratch in a slightly different ad hoc way for every project you create.
What could possibly go wrong?
-The Solution
+The Solution
Siesta ends this headache by providing a resource-centric alternative to the familiar request-centric approach.
@@ -285,7 +285,7 @@
Robust regression tests
Documentation and more documentation
-What it doesn’t do
+What it doesn’t do
- It doesn’t reinvent networking. Siesta delegates network operations to your library of choice (
NSURLSession by default, or Alamofire, or inject your own custom adapter).
@@ -299,7 +299,7 @@
For the open source transition, we took the time to rewrite our code in Swift — and rethink it in Swift, embracing the language to make the API as clean as the concepts.
Siesta’s code is therefore both old and new: battle-tasted on the App Store, then reincarnated in a Swifty green field.
-Design Philosophy
+Design Philosophy
Make the default thing the right thing most of the time.
@@ -350,7 +350,7 @@
(In-depth discussion of Carthage on XC7 is here.)
The code in Extensions/ is not part of the Siesta.framework that Carthage builds. (This currently includes only Alamofire support.) You will need to include those source files in your project manually if you want to use them.
-Git Submodule
+Git Submodule
Clone Siesta as a submodule into the directory of your choice, in this case Libraries/Siesta:
@@ -367,7 +367,7 @@
Click the + button in the top left corner to add a Copy Files build phase. Set the directory to Frameworks. Click the + button and add Siesta.
-Basic Usage
+Basic Usage
Make a shared service instance for the REST API you want to use:
let MyAPI = Service(baseURL: "https://api.example.com")
@@ -463,7 +463,7 @@
Note that this example is not toy code. Together with its storyboard, this small class is a fully armed and operational REST-backed user interface.
-Your socks still on?
+Your socks still on?
Take a look at AFNetworking’s venerable UIImageView extension for asynchronously loading and caching remote images on demand. Seriously, go skim that code and digest all the cool things it does. Take a few minutes. I’ll wait. I’m a README. I’m not going anywhere.
@@ -505,7 +505,7 @@
(Well, OK, they’re not exactly identical. The Siesta version has more robust caching behavior, and will transparently update an image everywhere it is displayed if it’s refreshed.)
There’s a more featureful version of RemoteImageView already included with Siesta — but the UI freebies aren’t the point. “Less code” isn’t even the point. The point is that Siesta gives you an elegant abstraction that solves problems you actually have, making your code simpler and less brittle.
-Comparison With Other Frameworks
+Comparison With Other Frameworks
Popular REST / networking frameworks have different primary goals:
@@ -686,7 +686,7 @@
2. “Trivial” means lines containing only whitespace, comments, parens, semicolons, and braces.
Despite this capabilities list, Siesta is a relatively small codebase — about the same size as Alamofire, and 5.5x smaller than RestKit.
-What sets Siesta apart?
+What sets Siesta apart?
It’s not just the features. Siesta solves a different problem than other REST frameworks.
@@ -707,7 +707,7 @@
Examples
This repo includes a simple example project. Use Carthage to build its dependencies.
-Contributing and Getting Help
+Contributing and Getting Help
To report a bug, file an issue.
@@ -716,7 +716,7 @@
To submit a feature request / cool idea, file an issue.
To get help, post your question to Stack Overflow and tag it with siesta-swift. (Be sure to include the tag. It triggers a notification.)
-Pull Requests
+Pull Requests
Want to do something instead of just talking about it? Fantastic! Be bold.
diff --git a/document_siesta/after/api-docs/index.html b/document_siesta/after/api-docs/index.html
index 5f136915f..f264de1b2 100644
--- a/document_siesta/after/api-docs/index.html
+++ b/document_siesta/after/api-docs/index.html
@@ -197,7 +197,7 @@
-
+
iOS REST Client Framework
@@ -236,8 +236,8 @@
- Examples
- Contributing and Getting Help
-What’s It For?
-The Problem
+What’s It For?
+The Problem
Want your app to talk to a remote API? Welcome to your state nightmare!
@@ -250,7 +250,7 @@
Naturally you’ll want to rewrite all of this from scratch in a slightly different ad hoc way for every project you create.
What could possibly go wrong?
-The Solution
+The Solution
Siesta ends this headache by providing a resource-centric alternative to the familiar request-centric approach.
@@ -285,7 +285,7 @@
Robust regression tests
Documentation and more documentation
-What it doesn’t do
+What it doesn’t do
- It doesn’t reinvent networking. Siesta delegates network operations to your library of choice (
NSURLSession by default, or Alamofire, or inject your own custom adapter).
@@ -299,7 +299,7 @@
For the open source transition, we took the time to rewrite our code in Swift — and rethink it in Swift, embracing the language to make the API as clean as the concepts.
Siesta’s code is therefore both old and new: battle-tasted on the App Store, then reincarnated in a Swifty green field.
-Design Philosophy
+Design Philosophy
Make the default thing the right thing most of the time.
@@ -350,7 +350,7 @@
(In-depth discussion of Carthage on XC7 is here.)
The code in Extensions/ is not part of the Siesta.framework that Carthage builds. (This currently includes only Alamofire support.) You will need to include those source files in your project manually if you want to use them.
-Git Submodule
+Git Submodule
Clone Siesta as a submodule into the directory of your choice, in this case Libraries/Siesta:
@@ -367,7 +367,7 @@
Click the + button in the top left corner to add a Copy Files build phase. Set the directory to Frameworks. Click the + button and add Siesta.
-Basic Usage
+Basic Usage
Make a shared service instance for the REST API you want to use:
let MyAPI = Service(baseURL: "https://api.example.com")
@@ -463,7 +463,7 @@
Note that this example is not toy code. Together with its storyboard, this small class is a fully armed and operational REST-backed user interface.
-Your socks still on?
+Your socks still on?
Take a look at AFNetworking’s venerable UIImageView extension for asynchronously loading and caching remote images on demand. Seriously, go skim that code and digest all the cool things it does. Take a few minutes. I’ll wait. I’m a README. I’m not going anywhere.
@@ -505,7 +505,7 @@
(Well, OK, they’re not exactly identical. The Siesta version has more robust caching behavior, and will transparently update an image everywhere it is displayed if it’s refreshed.)
There’s a more featureful version of RemoteImageView already included with Siesta — but the UI freebies aren’t the point. “Less code” isn’t even the point. The point is that Siesta gives you an elegant abstraction that solves problems you actually have, making your code simpler and less brittle.
-Comparison With Other Frameworks
+Comparison With Other Frameworks
Popular REST / networking frameworks have different primary goals:
@@ -686,7 +686,7 @@
2. “Trivial” means lines containing only whitespace, comments, parens, semicolons, and braces.
Despite this capabilities list, Siesta is a relatively small codebase — about the same size as Alamofire, and 5.5x smaller than RestKit.
-What sets Siesta apart?
+What sets Siesta apart?
It’s not just the features. Siesta solves a different problem than other REST frameworks.
@@ -707,7 +707,7 @@
Examples
This repo includes a simple example project. Use Carthage to build its dependencies.
-Contributing and Getting Help
+Contributing and Getting Help
To report a bug, file an issue.
@@ -716,7 +716,7 @@
To submit a feature request / cool idea, file an issue.
To get help, post your question to Stack Overflow and tag it with siesta-swift. (Be sure to include the tag. It triggers a notification.)
-Pull Requests
+Pull Requests
Want to do something instead of just talking about it? Fantastic! Be bold.