Automatically Generate TypeScript Definitions for GraphQL Queries with Apollo Codegen

faraz amiruddin
Dec 20, 2018 · 4 min read
Image for post
Image for post
So happy together


npx create-react-app react-apollo-typescript --typescript
yarn add graphql apollo-boost react-apollo
yarn add -D apollo @types/graphql

Downloading Our GraphQL Schema

yarn run apollo schema:download --endpoint= graphql-schema.json
✔ Loading Apollo Project
✔ Saving schema to graphql-schema.json

Creating a GraphQL Query and Generating Type Definitions

yarn run apollo codegen:generate --localSchemaFile=graphql-schema.json --target=typescript --includes=src/**/*.ts --tagName=gql --addTypename --globalTypesFile=src/types/graphql-global-types.ts types
✔ Loading Apollo Project
✔ Generating query files with 'typescript' target - wrote 2 files

Using Our Typed Query in React

Thanks for reading!

Hey! I’m Faraz.

I’m a software engineer @ AdHawk.

I like to write about react, react native, javascript, basketball, and film.

If you liked this article, please recommend and share it!

Open GraphQL

Anything & Everything GraphQL

Welcome to a place where words matter. On Medium, smart voices and original ideas take center stage - with no ads in sight. Watch

Follow all the topics you care about, and we’ll deliver the best stories for you to your homepage and inbox. Explore

Get unlimited access to the best stories on Medium — and support writers while you’re at it. Just $5/month. Upgrade

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store