APIRequestConfigurationType

public protocol APIRequestConfigurationType : URLConvertible, URLRequestConvertible

A protocol that needs to be conformed to by custom server API request configurations.

  • host

    Server host address.

    Declaration

    Swift

    var host: String? { get }
  • path

    URL path.

    Declaration

    Swift

    var path: String { get }
  • method

    Http method.

    Declaration

    Swift

    var method: Alamofire.HTTPMethod { get }
  • customHeaders

    Custom API header fields.

    Declaration

    Swift

    var customHeaders: [String : String] { get set }
  • multipartFormData

    Multipart form data.

    Declaration

    Swift

    var multipartFormData: Alamofire.MultipartFormData? { get }
  • parameters

    URL parameters.

    Declaration

    Swift

    var parameters: [(Alamofire.ParameterEncoding, [String : CustomStringConvertible])] { get }
  • requiresAccessToken

    Set to true if API call requires access token.

    Declaration

    Swift

    var requiresAccessToken: Bool { get }
  • customErrorExtractor

    Custom error extractor closure. See CustomErrorExtractor

    Declaration

    Swift

    var customErrorExtractor: CustomErrorExtractor? { get }
  • apiVersion

    Server API version.

    Declaration

    Swift

    var apiVersion: Int { get set }
  • errorVersion

    Server API error version.

    Declaration

    Swift

    var errorVersion: Int { get set }