KKBOX Open API Swift 1.1.7

KKBOX Open API Swift 1.1.7

×

由杨柳维护。

KKBOX Open API Swift 1.1.7

  • 作者：
  • zonble

KKBOX Open API Swift 开发者 SDK for iOS/macOS/watchOS/tvOS

© 2019 KKBOX.

Actions Status  build  License Apache  CocoaPods  Support  Support  Support  Support 

KKBOX的开放API提供了从 KKBOX 丰富的音乐档案中的各种数据。它可以帮助您访问KKBOX歌曲轨道、专辑、艺术家播放列表等相关数据。

这是一个纯 Swift 实现的访问KKBOX开放API的客户端。您可以使用 Swift 包管理器或CocoaPods轻松地将SDK集成到iOS/macOS/watchOS/tvOS项目中。

SDK利用了许多Swift编程语言的功能，如将API响应包装到枚举中，以及从Swift 4开始的JSON编码器/解码器。

另一方面，无法直接在您的Objective-C代码中调用SDK。如果您需要在Objective-C代码中与KKBOX的Open API协同工作，您可能需要在自己的桥接代码中包裹SDK，或者，您可能想查看KKBOX的Objective-C SDK。

如需更多信息，请访问KKBOX开发者网站。

需求

该SDK支持

  • Swift 4.2
  • 📱iOS 9.x或更高版本
  • 💻Mac OS X 10.10或更高版本
  • ⌚️watchOS 2.x或更高版本
  • 📺tvOS 9.x或更高版本

此SDK使用NSURLSession进行HTTP连接。由于NSURLSession尚未移植到Linux，因此即使在Linux上运行Swift，也无法在Linux上运行Swift SDK。

构建⚒

您需要最新版本的Xcode和macOS。建议使用Xcode 9和macOS 10.13 High Sierra。

安装

该SDK支持CocoaPods和Swift包管理器。

CocoaPods

SDK支持CocoaPods。请将pod 'KKBOXOpenAPISwift'添加到您的Podfile，然后执行pod install。

Carthage

将以下行添加到您的Cartfile

github 'KKBOX/OpenAPI-Swift'

然后运行carthage update。

Swift 包管理器

将 SDK 添加为您的 Package.swift 的依赖项

// swift-tools-version:4.0

import PackageDescription

let package = Package(
    name: "KKBOXOpenAPI-test",
    products: [
        .executable(name: "KKBOXOpenAPI-test", targets: ["YourTargetName"])
    ],
    dependencies: [
        .package(url: "https://github.com/KKBOX/OpenAPI-Swift", .upToNextMinor(from: "1.1.6"))
    ],
    targets: [
        .target(name: "YourTargetName", dependencies: ["KKBOXOpenAPISwift"], path: "./Path/To/Your/Sources")
    ]
)

使用方法

要开始使用 SDK，您需要创建一个 KKBOXOpenAPI 的实例。

let API = KKBOXOpenAPI(clientID: "YOUR_CLIENT_ID", secret: "YOUR_CLIENT_SECRET")

然后，通过传递客户端凭据询问实例获取访问令牌。

_ = try? self.API.fetchAccessTokenByClientCredential { result in
    switch result {
    case .error(let error):
        // Handle error...
    case .success(_):
        // Successfully logged-in
    }
}

最后，您可以开始进行 API 调用。例如，您可以通过调用 'fetchTrack' 来获取歌曲轨道的详细信息。

_ = try? self.API.fetch(track: "4kxvr3wPWkaL9_y3o_") { result in
    switch result {
    case .error(let error):
        // Handle error...
    case .success(let track):
        // Handle the song track.
    }
}

您可以使用 SDK 以及 Swift 或 Objective-C 编程语言开发您的应用程序，尽管这里我们只有 Swift 示例代码。

API 文档📖

许可证

版权所有 2019 KKBOX 技术有限公司

根据 Apache License，版本 2.0（《许可证》），您不得使用此文件，除非遵守许可证。您可以在以下位置获得许可证副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或经书面同意，否则在许可证下分发的软件按照"现状"提供，不提供任何明示或暗示的保证或条件。有关许可证的限制和许可权限的具体语言，请参阅许可证。