Alamofire

• 1. Core

  • 1.1. Session

  • 1.2. Request

  • 1.3. URLRequestConvertible

  • 1.4. HTTPMethod

  • 1.5. HTTPHeaders

  • 1.6. ParameterEncoder

  • 1.7. ParameterEncoding (Deprecated)

  • 1.8. Protected

  • 1.9. typealias

• 2. Feature

  • 2.1. CachedResponseHandler

  • 2.2. RedirectHandler

  • 2.3. EventMonitor

  • 2.4. RequestInterceptor

  • 2.5. Server Trust

  • 2.6. AlamofireExtended

    • 2.6.1. AlamofireExtended protocol

    • 2.6.2. AlamofireExtension struct

    • 2.6.3. AlamofireExtension+URLSessionConfiguration

    • 2.6.4. AlamofireExtension+Bundle

    • 2.6.5. AlamofireExtension+SecTrust

    • 2.6.6. AlamofireExtension+SecPolicy

    • 2.6.7. AlamofireExtension+SecTrustResultType

    • 2.6.8. AlamofireExtension+SecCertificate

    • 2.6.9. AlamofireExtension+Array

    • 2.6.10. AlamofireExtension+OSStatus

• 3. FAQ

  • 3.1. Result

1. Core

1.1. Session

1.2. Request

1.3. URLRequestConvertible

URLConvertible & URLRequestConvertible

Class Diagram

1.4. HTTPMethod

Class Diagram

1.5. HTTPHeaders

HTTPHeaders: An order-preserving and case-insensitive representation of HTTP headers.

Class Diagram

1.6. ParameterEncoder

Class Diagram

1.7. ParameterEncoding (Deprecated)

Class Diagram

1.8. Protected

Protected is defined as a Property Wrapper:

@propertyWrapper
@dynamicMemberLookup
final class Protected<T> {
    ...
}

Class Diagram

1.9. typealias

public typealias RequestModifier = (inout URLRequest) throws -> Void
public typealias Parameters = [String: Any]

2. Feature

2.1. CachedResponseHandler

Class Diagram

2.2. RedirectHandler

Class Diagram

2.3. EventMonitor

Class Diagram

2.4. RequestInterceptor

Class Diagram

2.5. Server Trust

Class Diagram

ServerTrustManager: Responsible for managing the mapping of ServerTrustEvaluating values to given hosts.

2.6. AlamofireExtended

Class Diagram

2.6.1. AlamofireExtended protocol

The AlamofireExtended protocol is used as namespace of all public extensions.

Note: Since AlamofireExtended has default implementations, so the class/struct which conform to this protocol can use these default implementation of af directly without implement them.

/// Protocol describing the `af` extension points for Alamofire extended types.
public protocol AlamofireExtended {
    /// Type being extended.
    associatedtype ExtendedType

    /// Static Alamofire extension point.
    static var af: AlamofireExtension<ExtendedType>.Type { get set }
    /// Instance Alamofire extension point.
    var af: AlamofireExtension<ExtendedType> { get set }
}

/// Add default implementation of the protocol functions
extension AlamofireExtended {
    /// Static Alamofire extension point.
    public static var af: AlamofireExtension<Self>.Type {
        get { AlamofireExtension<Self>.self }
        set {}
    }

    /// Instance Alamofire extension point.
    public var af: AlamofireExtension<Self> {
        get { AlamofireExtension(self) }
        set {}
    }
}

2.6.2. AlamofireExtension struct

All the public extension functions in Alamofire are implemented under the AlamofireExtension type.

Definition of AlamofireExtension:

/// Type that acts as a generic extension point for all `AlamofireExtended` types.
public struct AlamofireExtension<ExtendedType> {
    /// Stores the type or meta-type of any extended type.
    public private(set) var type: ExtendedType

    /// Create an instance from the provided value.
    ///
    /// - Parameter type: Instance being extended.
    public init(_ type: ExtendedType) {
        self.type = type
    }
}

2.6.3. AlamofireExtension+URLSessionConfiguration

Use case 1, adding extension for URLSessionConfiguration:

extension URLSessionConfiguration: AlamofireExtended {}
extension AlamofireExtension where ExtendedType: URLSessionConfiguration {
    /// Alamofire's default configuration. Same as `URLSessionConfiguration.default` but adds Alamofire default
    /// `Accept-Language`, `Accept-Encoding`, and `User-Agent` headers.
    public static var `default`: URLSessionConfiguration {
        let configuration = URLSessionConfiguration.default
        configuration.headers = .default

        return configuration
    }

    /// `.ephemeral` configuration with Alamofire's default `Accept-Language`, `Accept-Encoding`, and `User-Agent`
    /// headers.
    public static var ephemeral: URLSessionConfiguration {
        let configuration = URLSessionConfiguration.ephemeral
        configuration.headers = .default

        return configuration
    }
}

Call the extension functions:

URLSessionConfiguration.af.default

Note: As you can see in this example, extension functions are implemented under the AlamofireExtension, af returns an instance of AlamofireExtension.

Other public extensions defined in Alamofire are listed below.

2.6.4. AlamofireExtension+Bundle

extension Bundle: AlamofireExtended {}
extension AlamofireExtension where ExtendedType: Bundle {

    public var certificates: [SecCertificate] {
        ...
    }

    public var publicKeys: [SecKey] {
        ...
    }

    public func paths(forResourcesOfTypes types: [String]) -> [String] {
        ...
    }

}

2.6.5. AlamofireExtension+SecTrust

extension SecTrust: AlamofireExtended {}
extension AlamofireExtension where ExtendedType == SecTrust {

    public func evaluate(afterApplying policy: SecPolicy) throws {
        ...
    }

    public func validate(policy: SecPolicy, errorProducer: (_ status: OSStatus, _ result: SecTrustResultType) -> Error) throws {
        ...
    }

    public func apply(policy: SecPolicy) throws -> SecTrust {
        ...
    }

    public func evaluate() throws {
        ...
    }

    public func validate(errorProducer: (_ status: OSStatus, _ result: SecTrustResultType) -> Error) throws {
        ...
    }

    public func setAnchorCertificates(_ certificates: [SecCertificate]) throws {
        ...
    }

    public var publicKeys: [SecKey] {
        ...
    }

    public var certificates: [SecCertificate] {
        ...
    }

    public var certificateData: [Data] {
        ...
    }

    public func performDefaultValidation(forHost host: String) throws {
        ...
    }

    public func performValidation(forHost host: String) throws {
        ...
    }

}

2.6.6. AlamofireExtension+SecPolicy

extension SecPolicy: AlamofireExtended {}
extension AlamofireExtension where ExtendedType == SecPolicy {

    public static let `default` = SecPolicyCreateSSL(true, nil)

    public static func hostname(_ hostname: String) -> SecPolicy {
        ...
    }

    public static func revocation(options: RevocationTrustEvaluator.Options) throws -> SecPolicy {
        ...
    }

}

2.6.7. AlamofireExtension+SecTrustResultType

extension SecTrustResultType: AlamofireExtended {}
extension AlamofireExtension where ExtendedType == SecTrustResultType {
    public var isSuccess: Bool {
        ...
    }
}

2.6.8. AlamofireExtension+SecCertificate

extension SecCertificate: AlamofireExtended {}
extension AlamofireExtension where ExtendedType == SecCertificate {
    public var publicKey: SecKey? {
        ...
    }
}

2.6.9. AlamofireExtension+Array

extension Array: AlamofireExtended {}
extension AlamofireExtension where ExtendedType == [SecCertificate] {

    public var data: [Data] {
        ...
    }

    public var publicKeys: [SecKey] {
        ...
    }
}

2.6.10. AlamofireExtension+OSStatus

extension OSStatus: AlamofireExtended {}
extension AlamofireExtension where ExtendedType == OSStatus {
    public var isSuccess: Bool { ... }
}

3. FAQ

3.1. Result

Where does the Result instance construct from?

URLEncodedFormParameterEncoder -> open func encode<Parameters: Encodable>(...) :

let query: String = try Result<String, Error> { try encoder.encode(parameters) }
    .mapError { AFError.parameterEncoderFailed(reason: .encoderFailed(error: $0)) }.get()