Getting Started with Apollo iOS

Integrate Apollo iOS into your app

Follow the steps below to add Apollo iOS to your app:

1. Install the Apollo frameworks

You can add Apollo iOS into your project using Swift Package Manager or CocoaPods.

SPM with Package.swift

If your project uses its own Package.swift file, you can add Apollo iOS as a dependency there.

Add Apollo iOS to your dependencies list

Swift

Package.swift

1dependencies: [
2    .package(
3        url: "https://github.com/apollographql/apollo-ios.git",
4        .upToNextMajor(from: "1.0.0")
5    ),
6],

Link the Apollo product to your package target

Any targets in your application that will use ApolloClient need to have a dependency on the Apollo product.

Swift

Package.swift

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

Note: Targets that only use Apollo's generated models don't need to be linked to the Apollo product.

SPM with Xcode Project

If using Swift Package Manager within an Xcode project or workspace, use the Xcode project configuration UI to add the Apollo iOS package.

Go to File > Add Packages... Adding an SPM package

In the dialog that appears, paste the URL of the Apollo iOS GitHub repo (https://github.com/apollographql/apollo-ios.git) into the search bar, then select the apollo-ios package that appears: Pasting the Apollo iOS GitHub URL

Select which version you want to use (see version history), then click Add Package.

Note: Xcode might not automatically select the latest version number, please check.

Select which packages you want to use. If you're getting started, we recommend selecting just the main Apollo library for now. You can always add other packages later if you need them. Selecting Apollo iOS packages

Notes:
Do not select the Apollo-Dynamic product unless your project is configured to use dynamic linking of the Apollo iOS framework. Most projects do not need to link to this product.
Do not select the apollo-ios-cli package. This product is the CLI executable for code generation. If you link it to your project as a dependency it will cause build errors.

Then, click Add Package.

You're done!

CocoaPods

Install or update CocoaPods

Because Apollo iOS uses Swift 5, you need to use CocoaPods version 1.7.0 or later. You can install CocoaPods with the following command:

1gem install cocoapods

Add dependencies

Add pod "Apollo" to your Podfile.

To include the ApolloSQLite framework, also add pod "Apollo/SQLite"
To include the ApolloWebSocket framework, also add pod "Apollo/WebSocket"

Run pod install.

Use the .xcworkspace file generated by CocoaPods to work on your project.

You're done!

2. Add a schema file to your target directory

For Apollo iOS to generate models for your GraphQL operations, you need a local copy of your GraphQL server's schema.

See Downloading a schema for more details.

3. Create `.graphql` files for your GraphQL operations

Apollo iOS generates code from the GraphQL queries and mutations defined in your target's files. To use Apollo iOS, you'll need to define at least one operation GraphQL operation.

GraphQL operation and fragment definitions traditionally have the file extension .graphql. The generated models will have the file extension .graphql.swift.

See Defining operations for more details.

4. Setup and run code generation

Apollo iOS code generation uses your .graphql files to generate API code that helps you execute GraphQL operations and parse and cache operation responses.

Whenever you make changes to your GraphQL operation definitions, you'll need to run the code generation engine to re-generate your GraphQL models.

The easiest way to do this is with the Codegen CLI provided with Apollo iOS.

For more advanced usage and configuration (including use with modularized projects), see Code Generation.
To use Apollo's code generation and schema downloader from within any Swift script or library, check out Running code generation in Swift code.

SPM with Package.swift

Install the Codegen CLI

Bash

1swift package --allow-writing-to-package-directory apollo-cli-install

After the plugin installs, it creates a symbolic link to the Codegen CLI (named apollo-ios-cli) in your project root folder. You can now run the CLI from the command line using ./apollo-ios-cli.

Note: Because the apollo-ios-cli in your project root is only a symbolic link, it only works if the compiled CLI executable exists. This is generally located in your Xcode Derived Data or the .build folder. If these are cleared, you can rerun the Install CLI plugin to rebuild the CLI executable.

Initialize the code generation configuration

The Codegen CLI uses a JSON file to configure the code generation engine. You can use the Codegen CLI's init command to create this file with default values.From your project's root directory, run the following command with your customized values:

Bash

1./apollo-ios-cli init --schema-namespace ${MySchemaName} --module-type ${ModuleType}

${MySchemaName} provides a name for the namespace of your generated schema files.
${ModuleType} configures how your generated schema types are included in your project.
This is a crucial decision to make before configuring code generation. To determine the right option for your project, see Project Configuration.To get started quickly, you can use the embeddedInTarget option. Using embeddedInTarget, you must supply a target name using the --target-name command line option.

Running this command creates an apollo-codegen-config.json file.

Configure code generation options

Open your apollo-codegen-config.json file to start configuring code generation for your project.The default configuration will:

Find all GraphQL schema files ending with the file extension .graphqls within your project directory.
Find all GraphQL operation and fragment definition files ending with the file extension .graphql within your project directory.
Generate Swift code for the schema types in a directory with the schema-name provided.
Generate Swift code for the operation and fragment models in a subfolder within the schema types output location.

Run code generation

From your project's root directory, run:

Bash

1./apollo-ios-cli generate

The code generation engine creates your files with the extension .graphql.swift.

Add the generated schema and operation files to your target

By default, a directory containing your generated schema files is within a directory with the schema name you provided (i.e., MySchemaName). Your generated operation and fragment files are in a subfolder within the same directory.If you created your target in an Xcode project or workspace, you'll need to manually add the generated files to your target.

Note: Because adding generated files to your Xcode targets must be done manually each time you generate new files, we highly recommend defining your project targets with SPM. Alternatively, you can generate your operations into the package that includes your schema files. For more information see the documentation for Code Generation Configuration.

SPM with Xcode Project

Install the Codegen CLI

The Apollo iOS SPM package includes the Codegen CLI as an executable target. This ensures you always have a valid CLI version for your Apollo iOS version.To simplify accessing the Codegen CLI, you can run the included InstallCLI SPM plugin.This plugin builds the CLI and creates a symbolic link to the executable in your project root.If you use Swift packages through Xcode, you can right-click on your project in the Xcode file explorer, revealing an Install CLI plugin command. Selecting this command presents a dialog allowing you to grant the plugin "write" access to your project directory. Where to find the SPM plugin commands in Xcode

Where to find the SPM plugin commands in Xcode

After the plugin installs, it creates a symbolic link to the Codegen CLI (named apollo-ios-cli) in your project root folder. You can now run the CLI from the command line with ./apollo-ios-cli.

Note: Because the apollo-ios-cli in your project root is only a symbolic link, it only works if the compiled CLI executable exists. This is generally located in your Xcode Derived Data or the .build folder. If these are cleared, you can rerun the Install CLI plugin to rebuild the CLI executable.

Initialize the code generation configuration

Bash

1./apollo-ios-cli init --schema-namespace ${MySchemaName} --module-type ${ModuleType}

${MySchemaName} provides a name for the namespace of your generated schema files.
${ModuleType} configures how your generated schema types are included in your project.
This is a crucial decision to make before configuring code generation. To determine the right option for your project, see Project Configuration.To get started quickly, you can use the embeddedInTarget option. Using embeddedInTarget, you must supply a target name using the --target-name command line option.

Running this command creates an apollo-codegen-config.json file.

Configure code generation options

Open your apollo-codegen-config.json file to start configuring code generation for your project.The default configuration will:

Find all GraphQL schema files ending with the file extension .graphqls within your project directory.
Find all GraphQL operation and fragment definition files ending with the file extension .graphql within your project directory.
Generate Swift code for the schema types in a directory with the schema-name provided.
Generate Swift code for the operation and fragment models in a subfolder within the schema types output location.

Run code generation

From your project's root directory, run:

Bash

1./apollo-ios-cli generate

The code generation engine creates your files with the extension .graphql.swift.

Add the generated schema and operation files to your target

Note: Because adding generated files to your Xcode targets must be done manually each time you generate new files, we highly recommend defining your project targets with SPM. Alternatively, you can generate your operations into the package that includes your schema files. For more information see the documentation for Code Generation Configuration.

Cocoapods

Install the Codegen CLI

If you use Cocoapods, Apollo iOS compiles the Codegen CLI into an executable shell application during pod install (located in Pods/Apollo/apollo-ios-cli).After installing the Apollo iOS pod, you can run the Codegen CLI from the directory of your Podfile:

Bash

1./Pods/Apollo/apollo-ios-cli ${Command Name} -${Command Arguments}

Note: If you are using :path in your Podfile to link to a local copy of Apollo iOS, the CLI will not be automatically available. You will need to manually build the Codegen CLI. See the CLI installation guide for directions on how to do that.

Initialize the code generation configuration

Bash

1./Pods/Apollo/apollo-ios-cli init --schema-namespace ${MySchemaName} --module-type ${ModuleType}

${MySchemaName} provides a name for the namespace of your generated schema files.
${ModuleType} configures how your generated schema types are included in your project.
This is a crucial decision to make before configuring code generation. To determine the right option for your project, see Project Configuration.To get started quickly, you can use the embeddedInTarget option. Using embeddedInTarget, you must supply a target name using the --target-name command line option.

Running this command creates an apollo-codegen-config.json file.

Configure code generation options

Open your apollo-codegen-config.json file to start configuring code generation for your project.The default configuration will:

Find all GraphQL schema files ending with the file extension .graphqls within your project directory.
Find all GraphQL operation and fragment definition files ending with the file extension .graphql within your project directory.
Generate Swift code for the schema types in a directory with the schema-name provided.
Generate Swift code for the operation and fragment models in a subfolder within the schema types output location.

Run code generation

From your project's root directory, run:

Bash

1./Pods/Apollo/apollo-ios-cli generate

The code generation engine creates your files with the extension .graphql.swift.

Add the generated schema and operation files to your target

Note: Because adding generated files to your Xcode targets must be done manually each time you generate new files, we highly recommend defining your project targets with SPM. Alternatively, you can generate your operations into the package that includes your schema files. For more information see the documentation for Code Generation Configuration.

5. Create an `ApolloClient`

Before you can execute GraphQL operations in your app, you need to initialize an ApolloClient instance.

Swift

1import Foundation
2import Apollo
3
4let apolloClient = ApolloClient(url: URL(string: "http://localhost:4000/graphql")!)

See Creating a client for more details.

6. Fetch a query

ApolloClient can fetch your generated operation definitions, and return the response as a type-safe generated data model.

For example, if you define a query called HeroName:

GraphQL

1query HeroName {
2  hero {
3    name
4  }
5}

Apollo iOS will generate a HeroNameQuery class that you can construct and pass to ApolloClient.fetch(query:):

Swift

1apolloClient.fetch(query: HeroNameQuery()) { result in
2  guard let data = try? result.get().data else { return }
3  print(data.hero.name) // Luke Skywalker
4}

See Fetching data for more details.

Log Exporters

Metrics Exporters

Trace Exporters

Instrumentation

AWS Lattice