在Swift代码中运行代码生成

对于大多数用例，Apollo iOS Codegen CLI是生成代码和下载您的模式的推荐方法。CLI使用ApolloCodegenLib执行这些操作。ApolloCodegenLib用于执行这些操作。

要启用高级使用，ApolloCodegenLib可以作为您自己的Swift项目的依赖项包含。这使您可以使用Swift脚本执行CLI无法完成的操作。直接调用ApolloCodegenLib允许您以您想要的方式将Apollo集成到开发过程中。

安装`ApolloCodegenLib`

该ApolloCodegenLib作为Apollo iOS Codegen的SPM包的一部分。

目前，ApolloCodegenLib仅支持macOS。您无法在其他平台上运行代码生成脚本。

要在您自己的Swift项目中使用它，只需将其作为依赖项包含即可。

Package.swift

1
.target(
2
    name: "MyApp",
3
    dependencies: [
4
        .product(name: "ApolloCodegenLib", package: "apollo-ios-codegen"),
5
    ]
6
)

重要：由于代码生成与Apollo iOS SDK的使用相关联，请确保您使用了相同版本的apollo-ios和apollo-ios-codegen包。

使用方法

一旦您在项目中安装了ApolloCodegenLib依赖项，您可以使用它来：

安装ApolloCodegenLib
使用方法
- 运行代码生成
- 下载模式

运行代码生成

要使用ApolloCodegenLib配置和运行代码生成，创建一个ApolloCodegenConfiguration，然后将它传递给ApolloCodegen.build(with configuration:withRootURL:itemsToGenerate:)函数。

默认情况下，代码生成引擎会将ApolloCodegenConfiguration中的所有文件路径解析为当前工作目录。可以使用rootURL参数来提供要运行代码生成的项目的根目录的本地文件路径URL。这将在提供的rootURL相对于解析您的配置中的文件路径。

1
import ApolloCodegenLib
2

3
let configuration = ApolloCodegenConfiguration(
4
    schemaNamespace: "MyGraphAPI",
5
    input: ApolloCodegenConfiguration.FileInput(
6
        schemaSearchPaths: ["**/*.graphqls"],
7
        operationSearchPaths: ["**/*.graphql"]
8
    ),
9
    output: ApolloCodegenConfiguration.FileOutput(
10
        schemaTypes: ApolloCodegenConfiguration.SchemaTypesFileOutput(
11
            path: "./generated/schema/",
12
            moduleType: .swiftPackageManager
13
        ),
14
        operations: .inSchemaModule,
15
        testMocks: .none
16
    ),
17
    options: ApolloCodegenConfiguration.OutputOptions(
18
        additionalInflectionRules: [
19
            .pluralization(
20
                singularRegex: "animal",
21
                replacementRegex: "animals"
22
            )
23
        ],
24
        queryStringLiteralFormat: .multiline,
25
        deprecatedEnumCases: .include,
26
        schemaDocumentation: .include,
27
        apqs: .disabled,
28
        cocoapodsCompatibleImportStatements: false,
29
        warningsOnDeprecatedUsage: .include,
30
        conversionStrategies: ApolloCodegenConfiguration.ConversionStrategies(
31
            enumCases: .camelCase
32
        ),
33
        pruneGeneratedFiles: true
34
    )
35
)
36

37
try! ApolloCodegen.build(with: configuration)

有关配置代码生成的更多信息，请参阅配置文档。

下载模式

如果您想从您的Swift项目中下载一个GraphQL模式，请使用ApolloSchemaDownloader。

模式下载器可以配置为使用 ApolloSchemaDownloadConfiguration.

1
import ApolloCodegenLib
2

3
let configuration = ApolloSchemaDownloadConfiguration(
4
    using: .introspection(endpointURL: endpoint, outputFormat: .SDL),
5
    outputPath: outputURL.path
6
)
7

8
try! ApolloSchemaDownloader.fetch(configuration: configuration)

有关模式获取的更多信息，请参阅下载模式.

下载模式

代码生成故障排除

在Swift代码中运行代码生成

安装ApolloCodegenLib

使用方法

运行代码生成

下载模式

安装`ApolloCodegenLib`