AutoAPI Swift SDK

Auto API AutoAPI Swift SDK 的目的是帮助开发者在 Swift 中序列化 AutoAPI 数据,从而使他们不必担心自己解析和生成字节。该 SDK 基于 AutoAPI 规范生成。

目录

特性

序列化:该库旨在将 AutoAPI 数据序列化为 Swift 类型,或从 Swift 类型反序列化为 AutoAPI 数据。

支持更新:对 AutoAPI 规范的更新(非二进制)将与该库的旧版本一起使用,并且可以访问新的数据类型。

集成

该库以 Swift Package 的形式分发,允许与 Xcode 的内置 SPM 一起使用,或直接在 Package.swift 中使用。

要通过 Xcode 使用该软件包,可以在 File > Swift Packages > ... 中添加,或者转到项目设置并在顶部中心选择 Swift Packages
当以 Swift 包为目标时,Package.swift 文件必须在 dependencies 下包含 .package(url: "https://github.com/highmobility/auto-api-swift", .upToNextMinor(from: "[__version__]")),

要求

AutoAPI Swift SDK 需要 Xcode 11.0 或更高版本,并且与面向 iOS 10.0 或更高版本的应用程序兼容。

入门

通过阅读 high-mobility.com 中的 iOS AutoAPI 指南 开始。

查看 规范 以获取有关结构和逻辑的更多详细信息,或查看基于该规范生成的其他库:Android, Elixir

示例

Github.com 上有 3 个示例应用程序,用于展示 AutoAPI(和 HMKit)的用法

贡献

我们很乐意接受您对该项目的补丁和贡献。在开始工作之前,请首先通过 GitHub IssuesSpectrumSlack 与我们讨论您希望进行的更改。

用于创建此库的基于 AutoAPI 规范的生成器将在不久的将来开源。在此之前,对 Swift 界面的更改需要通过我们的私有生成器进行。如果您想更改 AutoAPI,请参阅 此处

版本发布通过标记的提交完成(根据 SPM 的要求,请在此处阅读更多相关信息:这里这里)。

CONTRIBUTING.md 中查看更多信息

许可证

此存储库使用 MIT 许可证。 在 LICENSE 中查看更多信息