按照以下步骤将 Apollo iOS 添加到您的应用程序中:
在安装 Apollo iOS 之前,请确保您使用的是最新版本的 Xcode。您可以通过Mac App Store更新 Xcode 。
您可以使用三个主要的 Cocoa 生态系统包管理器中的任何一个安装Apollo.framework到您的项目中:Swift 包管理器、CocoaPods 或 Carthage。
为了让 Apollo iOS 为您的 GraphQL 操作生成模型,您需要 GraphQL 服务器架构的本地副本。
确保将schema.json/schema.graphqls文件添加到大部分代码所在的文件夹,而不是.xcodeproj和/或文件所在的文件夹.xcworkspace。
这是一个示例文件结构:
| - your_project_folder
| your_project.xcodeproj
| - your_target_folder
| schema.json or schema.graphqls
| AppDelegate.swift
| ViewController.swift
| etc...
| - another_target_folder
| etc...
注意:您可以将架构文件放在不同的位置,但如果这样做,您需要修改以后步骤中显示的文件的所有相对路径。
.graphqlApollo iOS 从目标文件中定义的 GraphQL 查询和突变生成代码。作为一个有用的约定,您可以在使用相应操作的[operation].graphql任何文件旁边定义每个文件。[operation].swift
如果您安装了 Xcode 附加组件,则可以使用 Xcode 配套视图并排显示一个.swift文件及其对应的文件。.graphql
注意:如果您的构建树中还没有任何 .graphql文件,请创建一个包含基本有效操作的文件。如果不这样做,代码生成构建步骤会生成错误No operations or fragments found to generate code for。
Apollo iOS 代码生成使用您的.graphql文件生成 API 代码,帮助您执行所有形式的 GraphQL 操作,以及解析和缓存操作响应。要将代码生成作为 Xcode 构建过程的一部分运行,您需要创建一个在“编译源代码”之前运行的构建步骤以调用包装脚本。
包装脚本调用包含的二进制文件和构成apollo命令行界面的文件。这有助于确保您可以使用我们的工具,而不必担心库之间的版本控制不匹配。
检查一下:不要在 Bash 中编写其余部分,而是尝试使用我们新的Swift 脚本库,现在处于 Beta 版!它支持下载模式和生成代码。
这个包装脚本的位置取决于你如何将 Apollo 集成到你的项目中,但这些第一步总是相同的:
在应用程序目标的Build Phases设置选项卡上,单击+图标并选择New Run Script Phase。
在创建的运行脚本中,将其名称更改为Generate Apollo GraphQL API。
将这个新的运行脚本拖到构建阶段列表中的编译源上方,以便在编译代码之前执行它。
为您正在使用的包管理器添加适当的运行脚本的内容:
此时,您可以尝试在 Xcode 中构建您的目标。这将验证代码生成构建步骤是否可以正确定位您的架构文件。
故障排除
如果您收到此错误:
Cannot find GraphQL schema file [...]
该脚本找不到您的架构文件。仔细检查您使用的路径。
如果您收到此错误:
No operations or fragments found to generate code for.
您尚未在构建树中定义至少一个.graphql具有有效操作的文件。
如果您需要验证 GraphQL 操作的结构,您可以使用Apollo Sandbox针对您的 GraphQL 服务器对其进行测试。
将生成的API.swift文件拖到您的目标上。
注意:因为 Apollo iOS 生成特定于操作的结果类型,API.swift所以此时大部分为空,除非您已经将多个.graphql文件添加到目标目录。
确保取消选中“如果需要则复制文件”复选框,因为它应该已经在项目的文件夹系统中。然后,确保您已经检查了 API 文件需要包含的所有目标。
安装完成!您现在可以开始在您的应用程序中执行 GraphQL 操作。
你适合学Java吗?4大专业测评方法
代码逻辑 吸收能力 技术学习能力 综合素质
先测评确定适合在学习