ShopGunSDK
简介
这是一个框架,用于在您的应用程序中与 ShopGun API 交互。SDK 已分为多个组件
组件 | 描述 |
---|---|
PagedPublicationView |
用于获取、渲染和与目录交互的视图。 |
IncitoPublication |
用于获取、渲染和与数字目录(一个 "Incito")交互的视图控制器。 |
CoreAPI |
简化了与 ShopGun REST API 的身份验证和通信。 |
GraphAPI |
一个用于轻松向 ShopGun 的 GraphQL API 发送请求的接口。 |
EventsTracker |
一个事件追踪器,用于高效地发送分析事件。 |
指南
💾 安装
💡 入门
📚 API 文档
详细指南
快速开始
需求
- iOS 9.3+
- Xcode 9.0+
- Swift 4.2+
安装
将 ShopGunSDK
框架安装到您的应用程序中,首选方式是使用 CocoaPods。在您的 Podfile
中添加以下内容:
pod 'ShopGunSDK'
有关更详细的说明,请参阅 安装指南。
示例
此存储库使用 Swift 性能展厅来演示组件的示例用法。
- 下载/检出此存储库。
- 确保递归检出
External
文件夹中的所有子模块。 - 打开
ShopGunSDK.xcodeproj
,并构建 ShopGunSDK 方案(使用模拟器目标)。 - 打开项目内部引用的
ShopGunSDK.playground
。从这里,您将能够尝试使用 SDK。
注意:为了正确使用组件,它们必须配置为正确的 API 密钥。在表演厅的
Resources/ShopGunSDK-Config.plist
文件中设置值(从 ShopGun 开发者页面 可访问)为您的 API 密钥。另外注意:当涉及到导入外部框架时,Xcode 性能展厅可能会有些头疼。如果它抱怨,请尝试清理构建文件夹并重新构建 SDK(目标为模拟器),如果它继续这样做,请重新启动 Xcode。有时取消注释
playgroundLogHandler.swift
文件的内容,然后再取消注释,也能有所帮助。
有关更详细的指南,请参阅 入门指南。
更新日志
有关 SDK 变更的历史,请参阅 变更文件。
许可证
ShopGunSDK
以 MIT 许可证发布。有关详细信息,请参阅 许可证文档。