DetailedProductsKit

DetailedProductsKit是一个用于iOS和macOS的Swift库，用于管理与富兰克林坦博恩Detailed Product API的所有交互。

注意

为了使用DetailedProductsKit，您首先需要在富兰克林坦博恩开发者门户上注册、创建应用程序并获取凭据。

功能

• 与API进行身份验证
• 数据下载
• JSON解码
• 错误处理
• 响应缓存
• 三条代码即可启动运行

要求

• iOS 12.1+
• Xcode 10.2+
• Swift 5.0+

安装

DetailedProductsKit 通过 CocoaPods 提供。要将 DetailedProductsKit 集成到您的项目中，请将以下行添加到您的 Podfile，然后运行 pod install

pod 'DetailedProductsKit'

基础

DetailedProductsKit 提供的功能通过 DetailedProductsAPI 类暴露。

配置

将以下导入声明添加到您想使用 API 的类中

import DetailedProductsKit

创建一个常量

let productsAPI = DetailedProductsAPI(key: <#CONSUMER_KEY#>, secret: <#CONSUMER_SECRET#>)

使用

初始化 productsAPI 后，您可以调用任何支持的 API 端点。例如，要获取最新的基金净资产管理规模数据

productsAPI.getFundNav(fundKey: "US8802081039", fundKeyType: .isin) { (result) in
    DispatchQueue.main.async {
        switch result {
            case .success(let nav):
                // Handle success
            case .failure(let error):
                // Handle error
        }
    }
}

缓存

DetailedProductsAPI 默认会缓存 API 请求的响应。

如果您想禁用缓存，可以在初始化时进行操作

let productsAPI = DetailedProductsAPI(key: <#CONSUMER_KEY#>, secret: <#CONSUMER_SECRET#>, shouldCacheResponses: false)

Alternatively，您可以通过设置 shouldCacheResponses 变量为 false 来禁用缓存

productsAPI.shouldCacheResponses = false

如果您需要删除已缓存的响应，请调用以下方法

productsAPI.removeAllCachedResponses()

示例应用

已经包含了一个示例应用。将 ViewController 中的这一行更改为包含您的消费者密钥和密钥

let productsAPI = DetailedProductsAPI(key: "CONSUMER_KEY", secret: "CONSUMER_SECRET")

然后启动应用。

作者

Stuart Breckenridge

许可证

DetailedProductsKit 可在 MIT 许可下使用。更多信息请参阅 LICENSE 文件。