返回

Swift 适配 Mashape API 密钥：正确配置请求头

IOS

在 Swift 中适配 Mashape API 密钥

在使用 Mashape API 时，验证你的应用程序身份通常需要一个 API 密钥。这个密钥通常会以特定的 HTTP 请求头（header）传递。本篇文章讨论如何在 Swift 代码中正确配置和使用这个 API 密钥。

问题分析

问题的核心在于未能正确地在 HTTP 请求中包含X-Mashape-Key请求头，尽管尝试将其放在 response 回调方法内进行添加。在你的尝试代码中，设置 header 时机是错误的，因为它不参与请求发送，只参与响应的数据解析，并且是在获得数据后添加的。另外，尝试打印二进制数据本身会产生不友好的输出，直接处理 NSData 可能需要编码转换或其他额外的处理。正确做法是在请求发送前将此密钥加入到请求的头信息里。

解决方案

正确处理 Mashape 密钥的核心是将 X-Mashape-Key 头部信息添加到 NSURLRequest 对象中，并在请求被发送之前进行配置。这样做可以确保 API 服务器可以正确识别您的应用并允许访问资源。

步骤

  1. 创建 NSMutableURLRequest 对象 : 从 NSURLRequest 的一个可修改的版本 NSMutableURLRequest 开始。这样做，我们能修改请求，从而附加需要的头信息。
  2. 设置请求头 : 调用 addValue(_:forHTTPHeaderField:) 函数。传递 X-Mashape-Key 作为键和 API 密钥作为值来设置请求头。
  3. 发送请求 : 使用修改后的请求来执行网络请求。

代码示例

func getData() {
   let url = NSURL(string: "https://yoda.p.mashape.com/yoda?sentence=I+like+you")!
    let req = NSMutableURLRequest(URL: url)
    req.addValue("jY0bEhHCBpmsh8j1mpA5p11tCJGyp1tok3Zjsn4ubbvNNp5Jt3", forHTTPHeaderField: "X-Mashape-Key")
    

    NSURLConnection.sendAsynchronousRequest(req, queue: NSOperationQueue.mainQueue()) { (response, data, error) in
         if let error = error {
               print("请求出错: \(error)")
               return
         }
        
         guard let data = data else {
             print("无返回数据")
             return
         }

        
        do{
        if let json = try JSONSerialization.jsonObject(with: data, options: []) as? [String: Any] {
          print(json)
            }else {
                  let responseString = String(data: data, encoding: .utf8)
                        print("无法解析JSON，数据为字符串:\(responseString ?? "未知内容")")
                  }
        }catch {
              print("解析JSON失败:\(error)")
            let responseString = String(data: data, encoding: .utf8)
                        print("数据为字符串:\(responseString ?? "未知内容")")
        }
        
     
    }
}

这段修改后的代码将 X-Mashape-Key 添加到了 NSMutableURLRequest 对象中，使得 API 服务器能够识别并允许本次请求。成功发送请求后，会进行数据解析尝试，首先尝试JSON解析，失败则将返回数据以UTF8格式字符串打印。这样能够更清晰地看到响应内容。

安全建议

请注意，不要在客户端代码中硬编码API密钥。硬编码密钥会将你的 API 密钥暴露在反编译的程序或源代码管理工具中，对应用造成安全风险。建议考虑以下策略：

  • 使用环境变量： 将 API 密钥存储在应用程序的环境变量中，并在运行时读取它。
  • 使用后端代理： 让你的服务器端去调用 API， 客户端应用调用你的服务端接口，这样就可以防止密钥泄漏。
  • 使用安全存储机制： 如果在本地应用存储密钥，可以使用iOS的钥匙串服务。

以上建议旨在提高应用的安全水平，防范恶意利用的风险。