Shram

简单 Http 请求

Shram - 是一个易于使用但功能强大的通过 HTTP 请求与 RESTful 网络服务通信的框架。Shram 将帮助您用几行代码向服务器发送请求。此框架的主要优势是清晰和易用。

支持的平台

• IOS

如何安装

使用 Cocoapods，您需要在 podfile 中写入 pod 'Shram', '0.1.1’

如何工作

如上所述，Shram 非常易于使用。我们来了解一下。

您可以为 ShramRequest 创建对象

var request = ShramRequest(URL: "http://www.sample.com/api/method", method: "GET")

然后您可以设置以下参数

• parameters: [String : AnyObject]?
• headers: [String : String]?
• parseKeys: [String]?
• contentType: ContentType?
• timeOut: TimeInterval //默认值为 30.0

为了发送请求，您可以使用以下方法

send(completion, failure) 适用于一般请求

download(completion, progress, failure) 适用于带进度下载请求

upload(completion, progress, failure) 适用于带进度上传请求

例如

let params = [
        "someKey" : "someValue"
    ]

var request = ShramRequest(URL: "http://www.sample.com/api/method", method: "GET")
request.parameters = params as [String : AnyObject]?
req.send(completion: { (req, data, resp) in
            
}) { (req, err, resp) in
            
}

#另一种方式#

###方法 GET###

要发送简单的 GET 请求，您需要编写以下代码

Shram.GET("http://www.sample.com/api/method",
          completion: { (request, data, response) in
            
     },
          failure: { (request, error, response) in
     }
)

非常简单。但如果我们要传递一些参数或头信息呢？由于 Swift 允许为函数参数设置默认值，因此您无需寻找其他方法。完整版本的 GET 方法如下

Shram.GET("http://www.sample.com/api/method",
          params: params,
          headers: headers,
          withParseKeys: ["firstKey", "secondKey", ...],
          completion: { (request, data, response) in
     
     },
          failure: { (request, error, response) in
     
     }
)

让我们看看参数

• URL: API 方法的字符串值。
• params: 一个字典，其中键是服务器参数，值是要发送的参数。
• headers: 包含 HTTP 头信息的字典。
• withParseKeys: 要解析嵌套对象的键的字符串数组。例如，服务器以键 "data" 返回数据

{
    "data" : {
        "name": "userName",
        "age": "userAge"
    }
}

要从响应中得到所需数据，您需要将 withParseKeys: ["data"] 作为参数设置到 GET 函数中。

• completion: 当服务器响应成功时调用的闭包。返回

  • request: ShramRequest
  • data: Data?
  • response: ShramResponse?

• failure: 当请求失败或服务器返回错误时调用的闭包。返回

  • request: ShramRequest
  • error: Error?
  • response: ShramResponse?

如您所见，“params”、“headers”、“withParseKeys” 是可选的，您可以不传递它们而不需要它们。

###方法 POST###

方法 POST 类似。有简写和完整版本

Shram.POST("http://www.sample.com/api/method",
           contentType: contentType,
           completion: { (request, data, response) in
                    
     },
           failure: { (request, error, response) in
            
     }
)

Shram.POST("http://www.sample.com/api/method",
           params: params,
           contentType: contentType,
           headers: headers,
           withParseKeys: ["firstKey", "secondKey", ...],
           completion: { (request, data, response) in
     
     },
           failure: { (request, error, response) in
     
     }
)

在此方法中，您可以看到新的参数

• 内容类型：支持三种内容类型
  • application/json (.JSON)
  • application/x-www-form-urlencoded (.URLENCODED)
  • multipart/form-data (.MULTIPART_FORM_DATA)

###PUT方法###

Shram.PUT(http://www.sample.com/api/method,
          params: params,
          contentType: contentType,
          completion: { (request, data, response) in
                    
     },
          failure: { (request, error, response) in
     }
)

Shram.PUT(http://www.sample.com/api/method,
          params: params,
          contentType: contentType,
          headers: headers,
          withParseKeys: ["firstKey", "secondKey", ...],
          completion: { (request, data, response) in
                    
    },
         failure: {(request, error, response) in
    }
)

###DELETE方法###

Shram.DELETE("http://www.sample.com/api/method",
             completion: { (request, data, response) in
                        
     },
             failure: { (request, error, response) in
     }
)

Shram.DELETE("http://www.sample.com/api/method",
             params: params,
             headers: headers,
             withParseKeys: ["firstKey", "secondKey", ...],
             completion: { (request, data, response) in
                        
     },
             failure: { (request, error, response) in
     }
)