Request.md

Request

Configuration of a DataRequest.

Override the SLRequest

import SolarNetwork

class GitHubSigninRequest: SLRequest {
    
    // override the loadRequest method
    override func loadRequest() {
        super.loadRequest()
        
        //specify the method if is diffrent from target.method
        self.method = .put
        
        //specify the path
        self.path = "/authorizations/clients/\(GitHubAppClientID)"
    }
    
    /**
    the subClass's properties will encode to Parameters by Reflection.
    [
    "client_secret" : GitHubAppClientSecret, 
    "scopes": ["repo", "user"]
    ] 
    */
    var client_secret = GitHubAppClientSecret
        
    var scopes = ["repo", "user"]
}

Usage

//When you click the Signin button.
if let userName = userName, let password = password {
    
    let signinRequest = GitHubSigninRequest()
    //basic Authentication
    signinRequest.basicAuthentication = (userName, password)
    
    GitHubNetwork.request(signinRequest) { [weak self] (response) in
        
        if let model = response.decode(to: GitHubAuthenticationModel.self) {
            
            if model.token.count > 0 {
                //save token
            }
            
        }
        else if let error = response.error {
            //show error
        }
        
    }
}

You can also specify the following properties if you need.

public var method: HTTPMethod

public var path: String

//if specify URLString, it will ignore the target's baseURLString.
public var URLString: String

//if specify parameters, it will ignore the properties Reflection in subClass.
public var parameters: Parameters?

//specify the parameterEncoding if is diffrent from target.parameterEncoding.
public var parameterEncoding: ParameterEncoding

public var headers: [String: String]?

public var credential: URLCredential?
    
public var basicAuthentication: (user: String, password: String)?

//specify the dataKeyPath if is diffrent from target.status.dataKeyPath.
public var dataKeyPath: String?

Set BlackList of Request

import Foundation
import SolarNetwork

class HTTPBinPOSTRequest: SLRequest {
    
    override func loadRequest() {
        super.loadRequest()
        
        method = .post
        path = "/post"
//        parameterEncoding = JSONEncoding.default
        
        headers = ["test": "testValue"]
    }
    
    let testPOSTProperty = "testPOSTProperty"
    
    var name: String?
    
    let testBlackListProperty = "testBlackListProperty"

    //override the blackList, the parameters will no contain "testBlackListProperty"
    override var blackList: [String] {
        return ["testBlackListProperty"]
    }
}

Control the state of Request

let request = SubSLRequest()

request.pause()

request.resume()

//If cancel, you should send the request again.
request.cancel()

Custom ParameterEncoding

Alamofire not support String & Array parameters, if you wan to set String & Array parameters, you can use SLParameterValueJSONEncoding or SLParameterValuePropertyListEncoding.

//String Parameters

import Foundation
import SolarNetwork

class HTTPBinStringParametersRequest: SLRequest {
    
    override func loadRequest() {
        super.loadRequest()
        
        method = .post
        path = "/post"
        parameterEncoding = SLParameterValueJSONEncoding.default
    }
    
    let anyKey = "anyString"
}

HTTPBinNetwork.request(HTTPBinStringParametersRequest()) { (response) in 

}

//Array Parameters

import Foundation
import SolarNetwork

class HTTPBinArrayParametersRequest: SLRequest {

    override func loadRequest() {
        super.loadRequest()
        
        method = .post
        path = "/post"
        parameterEncoding = SLParameterValueJSONEncoding.default
    }
    
    let anyKey: [Any] = ["anyObj0", 1]
}

HTTPBinNetwork.request(HTTPBinArrayParametersRequest()) { (response) in

}