In this post, I want to explain something that tripped me up for a long time: how to generate TypeScript types from a GraphQL server.
"Wait, TypeScript types and GraphQL types are different??"#
They are! In fact, you even have types for your queries, which is extra confusing. Let me try to clarify.
So, in your GraphQL server you might expose a
User has fields like
profileImageUrl etc. When your client consumes this API it is over HTTP -- but if we're using TypeScript, it would be nice to have TypeScript types that match the GraphQL types.
GraphQL is "protocol" and language with a definition.
TypeScript is a programming language
*and they both have their own, separate, types.
This post shows you how to generate TypeScript types from your GraphQL server. And it's super handy because not only is your code type-checked, but your editor will also help you autocomplete.
Generating GraphQL TypeScript Types by Hand (lol don't do this)#
At first, you might try writing these types by hand, but this will just drive you crazy to maintain by hand as your app grows.
However, in a large scale production application, there could be hundreds of GraphQL endpoints & types. Take a look at GitHub's v4 GraphQL API, no joke, there are almost 1,000 endpoints & types. Creating TypeScript definitions for those (by hand) would be a nightmare!
Not only that, a change in the server means you will have to find and update your TypeScript definitions over and over again. Ew.
Of course every GraphQL API already has types defined in the schema. Wouldn't be great if there is something that can translate GraphQL types into TypeScript automatically?
As you've probably predicted, there is.
Ladies & gentleman, let me introduce to you, Apollo CLI.
The Apollo CLI is a robust command line interface that allows for a variety of different things such as schema validation, generate static types, and etc. And we'll use this tool to auto-generate TypeScript definitions from our GraphQL API. Here's how:
To use the Apollo CLI, we can install it globally with the following command:
There are two commands we are especially interested in:
download our GraphQL schema and save a copy of it in our client
auto generate the TypeScript definitions from our schema
We'll set up both of these steps as two separate script commands in our application's
package.json file. We'll label these scripts
Downloading the Schema#
To download the schema, we'll need to run the
apollo client:download-schema command and specify the options we would want. In our case, we'll specify the single minimum option we need - the endpoint and pass in the value of our local GraphQL endpoint (
We'll run the newly created
codegen:schema script in our command line.
After a brief period, we'll notice success messages that state
Loading Apollo Project and
Saving schema to schema.json.
If we look at the root of our
client/ directory, we'll notice a
schema.json file be generated that represents our entire GraphQL schema!