Nomics.com Swift SDK
目录
描述
NomicsSDK 是使用 Swift 编写的简单 API 接口,用于使用 Nomics.com API 的加密项目。
主要功能
- 适用于 iOS、tvOS、watchOS 和 macOS
- 通过枚举提供简单的 API 接口
- 类型安全 API 参数
- 易于扩展
- 单元测试范围广泛且文档齐全
用法
通用
实现和使用SDK非常简单。要开始使用,只需使用您喜欢的包管理器进行以下操作。或者,您可以手动安装它。
import NomicsSDK
然后,创建一个APIConfig
配置对象,并用它实例化SDK
let config = APIConfig(with: "2018-09-demo-dont-deploy-b69315e440beb145", for: .production)
let sdk = NomicsSDK(with: config)
之后,您可以按需使用请求端点
sdk.request(dataType: [Price].self,
endpoint: Endpoint.Currency.prices,
success: { data in
// Data is an array of price objects
}, error: { error in
// Can be a decoding error, or a request error
})
为了使通用请求和解码机制了解将传递到回调中的数据类型,您需要在请求方法调用中提供数据类型。
通常,您只会关注两种不同类型的调用
[Price].self
和
Price.self
前者是您想让SDK解码Price
对象的数组时,后者是一个单独的对象。您可以通过查看nomics.com的端点文档来了解哪种情况适合您,具体端点文档请参阅。
安装
CocoaPods
NomicsSDK可以通过CocoaPods获取。要安装,只需在Podfile中添加以下行
pod 'NomicsSDK'
Carthage
NomicsSDK还通过Carthage提供。要安装,只需在Cartfile中写入
github "ndizazzo/nomics-swift-sdk"
Swift Package Manager
NomicsSDK支持SPM!将以下行添加到您的Package.swift
文件
.Package(url: "https://github.com/ndizazzo/nomics-swift-sdk.git", from: "1.0.0")
作者
- Nomics.com 提供了此 SDK 交互的 API。
- 类 TinyNetworking 受益于objc.io 团队的努力。请参考源文件以获取更多背景信息,并查看他们的工作!
- Nick DiZazzo 创建了这项。
❤️
贡献
如果您想为此项目做出贡献,请查看CONTRIBUTING 指南以获取更多信息。
许可协议
NomicsSDK 在 MIT 许可下可用。有关更多信息,请参阅LICENSE 文件。