GraphQL Code Generator

graphql-code-generator.com

GraphQL Code Generator is a tool that generates code out of your GraphQL schema. Whether you are developing a frontend or backend, you can utilize GraphQL Code Generator to generate output from your GraphQL Schema and GraphQL Documents (query/mutation/subscription/fragment).

By analyzing the schema and documents and parsing it, GraphQL Code Generator can output code at a wide variety of formats, based on pre-defined templates or based on custom user-defined ones. Regardless of the language that you're using, GraphQL Code Generator got you covered.

GraphQL Code Generator let you choose the output that you need, based on plugins, which are very flexible and customizable. You can also write your own plugins to generate custom outputs that matches your needs.

You can try this tool live on your browser and see some useful examples. Check out GraphQL Code Generator Live Examples.

Quick Start

Install using npm (or yarn):

$ npm install graphql-code-generator

GraphQL Code Generator lets you setup everything by simply running the following command:

$ gql-gen init

Question by question, it will guide you through the whole process of setting up a schema, selecting plugins, picking a destination of a generated file and a lot more.

If you don't want to use the wizard, create a basic codegen.yml configuration file, point to your schema, and pick the plugins you wish to use. For example:

schema: http://localhost:3000/graphql
generates:
  src/types.ts:
    - typescript-common
    - typescript-server

Then, run the code-generator using gql-gen:

$ gql-gen

The command above may fetch (for example) the following GraphQL schema:

type Author {
  id: Int!
  firstName: String!
  lastName: String!
  posts(findTitle: String): [Post]
}

type Post {
  id: Int!
  title: String!
  author: Author!
}

type Query {
  posts: [Post]
}

schema {
  query: Query
}

And generate the following Typescript typings:

interface Query {
  posts?: Post[];
}

interface Post {
  id: number;
  title: string;
  author: Author;
}

interface Author {
  id: number;
  firstName: string;
  lastName: string;
  posts?: Post[];
}

interface PostsAuthorArgs {
  findTitle?: string;
}

Links

Besides our docs page, feel free to go through our published Medium articles to get a better grasp of what GraphQL Code Generator is all about:

Contributing

Feel free to open issues and pull requests. We're always welcome support from the community.

To run this project locally:

Use Node >= 8
Make sure that you have the latest Yarn version (https://yarnpkg.com/lang/en/docs/install/)
Clone this repo using git clone
Run yarn on the root dir (it has a Yarn workspace defined, so all the packages dependencies will be installed)
Run yarn build to build all core packages and plugins
Run yarn test to make sure everything works

License

MIT

leonardfactory / graphql-code-generator Goto Github PK