TrefleSwiftSDK 0.0.4

TrefleSwiftSDK 0.0.4

维护者 James Barrow



  • James Barrow

TrefleSwiftSDK

Swift Platforms SwiftPM Carthage CocoaPods Twitter

TrefleSwiftSDK 是围绕 Trefle API 的 Swift 包装器。

目前仍在开发中。以下列出了一些当前支持的功能。

  • 认证
  • 王国
  • 次王国
  • 分区
  • 植物
  • 物种
  • 分布区域
  • 操作支持
  • 组合支持
  • 全面错误处理
  • 基本测试套件
  • 深度测试套件

注意:当前版本的 TrefleSwiftSDK 基于版本 Trefle 1.6.0

先决条件

在开始之前,请确保您满足以下要求

安装

Swift 包管理器

要将 TrefleSwiftSDK 集成到您的 Xcode 项目中并使用 Swift 包管理器,请将 TrefleSwiftSDK 添加为依赖项到您的 Package.swift 文件的 dependencies 值。

dependencies: [
    .package(url: "https://github.com/Baza207/TrefleSwiftSDK.git", .upToNextMajor(from: "0.1.0"))
]

Carthage

使用 CarthageTrefleSwiftSDK 集成到您的 Xcode 项目中,请在您的 Cartfile 中指定它如下所示

github "Baza207/TrefleSwiftSDK" "0.1.0"

CocoaPods

使用 CocoaPodsTrefleSwiftSDK 集成到您的 Xcode 项目中,请在您的 Podfile 中指定它如下所示

pod 'TrefleSwiftSDK', '~> 0.1.0'

使用方法

基本设置

一旦您从您的 Trefle 个人资料中获取访问授权,您还需要在 Xcode 项目中创建一个 URL。为此,您可以按照以下步骤在 Apple 文档中 注册您的 URL 架构

有了这个之后,您就可以将 TrefleSwiftSDK 框架导入到项目中并进行设置。

  1. 在您的 AppDelegate 中导入 TrefleSwiftSDK
import TrefleSwiftSDK
  1. 通过在 application(_:didFinishLaunchingWithOptions:) 中调用 configure(accessToken:uri:) 设置 TrefleSwiftSDK,传入您的 Trefle 个人资料中获取的访问授权以及您在 Xcode 信息选项卡中设置的 URI。
Trefle.configure(accessToken: "<Access Token>", uri: "<Redirect URI>")
  1. 然后,您可以从项目中的任何管理器使用所有获取和搜索调用的功能。所有认证都由框架使用提供的访问授权来处理,这意味着您不需要担心用户的登录和注销。所有 JWT 认证和在过期令牌上的重新认证都是自动进行的。

贡献者

James Barrow

许可

MIT 许可协议