Swift中一个RESTful API的Put请求示例

Question

我正在尝试通过为Phillips Hue灯API创建OSX应用程序来学习Swift。但是，我感到有些愚蠢，我甚至无法使一个简单的例子工作。我在X Code 6.1中使用了这个库： https://github.com/hallas/agent 这是我使用的代码：

import Foundation



let done = { (response: NSHTTPURLResponse!, data: Agent.Data!, error: NSError!) -> Void in
    // react to the result of your request
};
Agent.put("/api/[username]/lights/2/state", headers: [ "Header": "Value" ],
    data: [ "hue": 35000 ], done: done)

毫无疑问，它没有做任何事情。我做错了什么？

- Amanda_Panda

---

你怎么知道它什么也没做？ - GoZoner

我正在使用飞利浦Hue网络界面，并获取所有灯泡的状态。数字没有改变。 - Amanda_Panda

你的done闭包是空的；也许Agent.put()报告了一个错误？使用 if error != null { /* print something; debugger break; etc */ }。 - GoZoner

您需要一个完整的URL。"/api/[username]/lights/2/state"没有域名。同时请删除多余的"headers"参数，您当前正在发送示例值。 - nickgraef

你需要定义协议，所以如果是基于Web的服务，URI将以“http://”或“https://”开头。 - user1932079

Answer 1

这是一个PUT操作的示例，使用一个简单的类来封装HTTP功能：

    let url = NSURL(string:"http://example.com")
    let text = "Text to PUT"
    var myData: NSData? = text.dataUsingEncoding(NSUTF8StringEncoding)
    var headers = Dictionary<String, String>()

    Http().put(url!, headers: headers, data:myData!) { (result) in           
        if result.success {
            if let jsonObject: AnyObject = result.jsonObject {
                println(jsonObject)
            }
        }
    }

class Http {

func put(url: NSURL, headers: Dictionary<String, String>, data: NSData, completionHandler: ((result: HttpResult) -> Void)!) {
    action("PUT", url: url, headers: headers, data: data ) { (result) in
        completionHandler(result: result)
    }
}

func action(verb: String, url: NSURL, headers: Dictionary<String, String>, data: NSData, completionHandler: ((result: HttpResult) -> Void)!) {
    let httpRequest = NSMutableURLRequest(URL: url)
    httpRequest.HTTPMethod = verb

    for (headerKey, headerValue) in headers {
        httpRequest.setValue(headerValue, forHTTPHeaderField: headerKey)
    }
    let task = NSURLSession.sharedSession().uploadTaskWithRequest(httpRequest, fromData: data) { (data, response, error) in
        completionHandler(result: HttpResult(data: data, request: httpRequest, response: response, error: error))
    }
    task.resume()
}
}

class HttpResult {

var request: NSURLRequest
var response: NSHTTPURLResponse?
var data: NSData?
var error: NSError?
var statusCode: Int = 0
var success: Bool = false
var headers : Dictionary<String, String> {
    get {
        if let responseValue = response {
            return responseValue.allHeaderFields as Dictionary<String,String>
        }
        else {
            return Dictionary<String, String>()
        }
    }
}

init(data: NSData?, request: NSURLRequest, response: NSURLResponse?, error : NSError?) {
    self.data = data
    self.request = request
    self.response = response as NSHTTPURLResponse?
    self.error = error
    self.success = false

    if error != nil {
        println("Http.\(request.HTTPMethod!): \(request.URL)")
        println("Error: \(error!.localizedDescription)")
    }
    else {
        if let responseValue = self.response {
            statusCode = responseValue.statusCode
            if statusCode >= 200 && statusCode < 300 {
                success = true
            }
            else {
                println("Http.\(request.HTTPMethod!) \(request.URL)")
                println("Status: \(statusCode)")
                if let jsonError: AnyObject = jsonObject {
                    var err: NSError?
                    var errData = NSJSONSerialization.dataWithJSONObject(jsonError, options:NSJSONWritingOptions.PrettyPrinted, error: &err)
                    var errMessage = NSString(data: errData!, encoding: NSUTF8StringEncoding)                     
                    println("Error: \(errMessage)")
                }
            }
        }
    }
}

var jsonObject: AnyObject? {
    var resultJsonObject: AnyObject?
    var jsonError: NSError?
    if let contentType = headers["Content-Type"] {
        if contentType.contains("application/json") {
            resultJsonObject = NSJSONSerialization.JSONObjectWithData(data!, options: .AllowFragments, error: &jsonError) as AnyObject?
        }
    }
    return resultJsonObject
}    
}

- whitneyland

---

抱歉，我以为你想要直接进行PUT操作，刚看到你的问题是关于Hue SDK特定的。 - whitneyland

是的，使用REST API PUT非常好，它并不特定于飞利浦Hue。 - whitneyland

Answer 2

使用 Swift 2 的示例

    let url = NSURL(string: "https://yourUrl.com") //Remember to put ATS exception if the URL is not https
    let request = NSMutableURLRequest(URL: url!)
    request.addValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type") //Optional
    request.HTTPMethod = "PUT"
    let session = NSURLSession(configuration:NSURLSessionConfiguration.defaultSessionConfiguration(), delegate: nil, delegateQueue: nil)
    let data = "username=[e-mail]&password=password".dataUsingEncoding(NSUTF8StringEncoding)
    request.HTTPBody = data

    let dataTask = session.dataTaskWithRequest(request) { (data, response, error) -> Void in

        if error != nil {

            //handle error
        }
        else {

            let jsonStr = NSString(data: data!, encoding: NSUTF8StringEncoding)
            print("Parsed JSON: '\(jsonStr)'")
        } 
    }
    dataTask.resume()

- Yunus Nedim Mehel

---

为什么不使用[String: AnyObject]类型来存储数据？ - Alexis Coquard

Answer 3

在您开始编写代码之前，请确保您已经按照Hue开发者网页上的入门指南http://www.developers.meethue.com/documentation/getting-started进行了操作。

特别是：

1. Find out your bridge ip address. The most simple way could be checking on your router. 

2. Open http://bridge_ip_address/debug/clip.html. You'll get a simple client. Try stuffs there.

在您测试了剪辑中可以进行更改后。然后返回您的Swift代码。 如评论中@nickgraef所提到的。端点应为：http://bridge_ip_address/api/[username]/lights/2/state。

Agent.put("http://bridge_ip_address/api/[username]/lights/2/state", headers: [ "Header": "Value" ],
    data: [ "hue": 35000 ], done: nil)

- Shuo