BoxSdkGen 0.3.0

BoxSdkGen 0.3.0

×

由 sdk-build 维护。

BoxSdkGen 0.3.0

  • 由
  • Box

“box-dev-logo”

Box Swift SDK 生成的

我们很高兴推出最新一代（目前处于测试版）的 Box Swift SDK Gen，它旨在提升开发者的体验并简化您对 Box Content Cloud 的集成。

使用此 SDK，您将获得：

  1. 完全的 API 支持：新一代的 Box SDK 为开发者提供了对 Box API 生态系统的全面覆盖。现在您可以访问 Box 提供的所有最新特性和功能，让您构建更复杂、功能更丰富的应用程序。
  2. 快速的 API 更新：告别等待新的 Box API 被集成进 SDK。使用我们新的自动生成开发方法，我们可以在短短几天内将新的 Box API 添加到 SDK 中，这意味着您无需等待即可利用您应用程序中最新的功能。
  3. 嵌入式文档：我们明白，对于开发者来说，轻松获取信息至关重要。使用我们新的方法，我们已经直接在 SDK 的源代码中包含了所有对象和参数的全面文档。这意味着您不再需要在中查找这些信息，这可以为您节省时间并简化您的开发过程。
  4. 增强的便捷方法：我们对提高您开发体验的承诺继续通过引入便捷方法。这些方法涵盖了诸如分块上传、分类等方面的各个层面。
  5. 无缝启动：新的 SDK 集成了认证、自动指数退避重试、异常处理、请求取消和类型检查等核心功能，使您能够专注于您应用程序的业务逻辑。

拥抱新一代的 Box SDK，释放 Box 内容云的全部潜力。

目录

安装

Swift 包管理器

Swift 包管理器是一个用于管理 Swift 代码分发的工具。它与 Swift 构建系统集成，以自动下载、编译和链接依赖项的过程。

要将依赖项添加到您的 Xcode 项目中，请点击“Xcode 项目文件”下的 包依赖项，然后点击加号图标添加包。然后输入以下存储库 URL https://github.com/box/box-swift-sdk-gen.git 并点击“下一步”。

或者，您可以在您的 Package.swift 的依赖项值中添加依赖项。

有关详细信息，请参阅SPM 的官方文档

Carthage

Carthage 是一个去中心化的依赖项管理器，它构建您的依赖项并为您提供二进制框架。

要将依赖项添加到 BoxSdkGen，您需要将以下行添加到您的 Cartfile 中

git "https://github.com/box/box-swift-sdk-gen.git"

然后运行

carthage bootstrap --use-xcframeworks

最后，将构建的 xcframework 从 Carthage/Build 拖入您的项目。

有关更详细的说明，请参见 Carthage 的官方文档。

入门

要开始使用 SDK，请从 Box 开发者控制台中获取您的应用的配置页面上的开发者令牌。您可以使用此令牌对您的 Box 账户进行测试调用。

SDK 提供了一个 BoxDeveloperTokenAuth 类，允许您使用开发者令牌进行身份验证。使用 BoxDeveloperTokenAuth 实例初始化 BoxClient 对象。使用 BoxClient 对象，您可以访问管理器，这允许您对您的 Box 账户执行一些操作。

以下示例演示了如何使用开发者令牌进行身份验证并打印根文件夹中所有项目的名称。

import BoxSdkGen

let auth = BoxDeveloperTokenAuth(token: "DEVELOPER_TOKEN_GOES_HERE")
let client = BoxClient(auth: auth)

let items = try await client.folders.getFolderItems(folderId: "0")
if let entries = items.entries {
    for entry in entries {
        switch entry {
        case let .fileMini(file):
            print("file \(file.name!) [\(file.id)]")
        case let .folderMini(folder):
            print("folder \(folder.name!) [\(folder.id)]")
        case let .webLinkMini(webLink):
            print("webLink \(webLink.name!) [\(webLink.id)]")
        }
    }
}

有关如何使用 SDK 调用 Box API 的文档，可以在 此处找到。

我们建议您熟悉其他认证方法、上传文件 和 下载文件。

集成测试

在本地运行集成测试

创建自定义应用程序

要本地运行集成测试，您需要在 Box 开发者控制台 中创建一个 Custom App，并在认证方法中选择 Server Authentication (Client Credentials Grant)。

  • 在 App Access Level 部分，选择 App + Enterprise Access。您可以启用所有 Application Scopes。
  • 在 Advanced Features 部分，启用 Make API calls using the as-user header 和 Generate user access tokens。

现在选择 Authorization 并提交申请以供账户管理员评审。

导出配置

要运行集成测试，您需要设置一些环境变量，指定您的账户和您创建的 Box 应用。

  1. 将环境变量 CLIENT_ID 设置为其在应用 OAuth 2.0 Credentials 部分的配置标签对应值。
  2. 将环境变量 CLIENT_SECRET 设置为其在应用 OAuth 2.0 Credentials 部分的配置标签对应值。
  3. 将环境变量 ENTERPRISE_ID 设置为其在应用 App Info 部分的“通用设置”标签对应值。
  4. 将环境变量 USER_ID 设置为其在应用 App Info 部分的“通用设置”标签对应值。
  5. 将环境变量 BOX_FILE_REQUEST_ID 设置为用户账户中已创建的文件请求的 ID， BOX_EXTERNAL_USER_EMAIL 使用不属于任何企业的免费外部用户的电子邮件。
  6. 将环境变量 WORKFLOW_FOLDER_ID 设置为触发工作流的文件的 Relay 工作流的 ID。该工作流应该有一个手动启动以能够从 API 启动。

运行测试

要本地运行集成测试

  1. swift test

有疑问、问题、功能请求吗？

直接联系我们？ 查看问题票据！ 或者，如果那不起作用，提交新问题，我们将回复您。如果您对 Box API 有一般性的问题，您可以发布到 Box 开发者论坛。

版权和许可

版权所有 ©2023 Box, Inc。

根据 Apache 许可证 2.0 版（“许可证”）；除非您遵守本许可证，否则不允许使用此文件。您可以在以下位置获得许可证副本：

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

除非适用法律或书面同意的要求外，在许可下分发的软件是根据“现状”基础分发的，不提供任何类型的明示或暗示保证或条件。有关许可下的具体语言、权限和限制，请参阅许可证。