This README describes how to generate typescript definitions for your GraphQL-based GraphAPI.

git clone https://github.com/graphapi-io/resources.git
cd resources

 npm i

1. Open your GraphAPI Settings on https://my.graphapi.io
2. You may be asked to log in to your API. If you haven't done it yet, sign up using the same email address you're signed in with on my.graphapi.io
3. Find "Authorization Settings"
4. Under "BASIC AUTHORIZATION" you should see "DEFAULT KEY". Technically you could use it, but it's a best practice to generate a separate key for each application/use case.
5. Click "Add Api Key" button in the section below
6. Provide a meaningful name and click "Create"
7. Copy the key
8. In the repository copy the .env.example file to .env file (or simply run cp .env.example .env)
9. Replace the API_KEY=<PROVIDE_YOUR_KEY_HERE> with actual key. For example API_KEY=yoursecretapikey

1. Go into your API Settings on https://my.graphapi.com
2. Click the "Copy to Clipboard" button
3. Replace the API_URL=<PROVIDE_YOUR_API_URL> with your actual url. For example: API_URL=https://yourapiurl.com/graphql

 npm run codegen

Now you can see that the src/generated/types.ts has been updated.

For this example we have a simple model consisting of:

1. Blog
2. Post
3. Comment

We also have a single enum PublishState that indicates weather the Post is published or not.

The types are generated based on two things: the schema and the graphql queries an mutations that we define in api directory.

The types based on the schema are always generated, and they consist of all of the scalars, enums and inputs, however, the query and mutation results are based on the .graphql files from the src/api directory.

As the only query we have is blog, the only query response in src/generated/types.ts is IQueryBlogQuery.

It makes sense as the power of graphql is that you can use the same api in different applications, and each of them can query different pieces of data. With this approach each application can get its own types as well.

Sign up to graphapi® @ https://my.graphapi.com/signup

Read our Code of Conduct at https://graphapi-io.github.io/

• graphapi® Terms of Service
• graphapi® Privacy Policy
• graphapi® Data Processing Agreement