apollo-codegen

Apollo client code generator

This is a tool to generate client code based on a GraphQL schema and query documents.

It currently only generates Swift code, and only for a subset of GraphQL queries. Most importantly, fragments are only supported if their type condition matches their parent type exactly. See Apollo iOS for details on the proposed mapping from GraphQL results to Swift types, as well as runtime support for performing queries.

Getting Started

Apollo iOS Quickstart is a sample Xcode project that makes it easy to get started with a generated API for your own schema and queries.

Usage

If you want to experiment with the tool, you can install the apollo-codegen command globally:

npm install apollo-codegen -g

To download a GraphQL schema by sending an introspection query to a server:

apollo-codegen download-schema http://localhost:8080/graphql --output GitHuntAPI/Definitions/schema.json

You can use the header option to add additional HTTP headers to the request. For example, to include an authentication token, use --header "Authorization: Bearer <token>".

To generate Swift code from a set of query definitions in .graphql files:

apollo-codegen generate GitHuntAPI/Definitions/**/*.graphql --schema GitHuntAPI/Definitions/schema.json --output GitHuntAPI/GitHuntAPI.swift

Changelog

apollo@2.11.0, apollo-language-server@1.8.0, apollo-graphql@0.3.0, apollo-language-server@1.8.0, apollo-env@0.5.0

• apollo@2.11.0
  • Leverage updates to apollo-language-server to support federated services #1251
  • Add service:delete command for deleting federated services #1251
• apollo-env@0.5.0
  • Add new utils and predicates #1251
• apollo-graphql@0.3.0
  • Require graphql@^14.2.1 #1251
  • Add buildSchemaFromSDL and related utilities for constructing partial schemas #1251
  • Add transformSchema and related utilities for easily transforming schemas #1251
• apollo-language-server@1.8.0
  • Fix windows file paths by normalizing all URIs to a consistent format #1213.
  • Fix positionToOffset to consider windows line endings #1213.
  • Extend Engine API for federated schema uploads and checks #1251
  • Reorganize files and exports #1251