Repository files navigation

Generate & scaffold type-safe resolvers based on your GraphQL Schema in TypeScript, Flow & Reason

graphqlgen has been officially deprecated in favor of theThe Guild's projectGraphQL Code Generator. Learn more about the collaboration of Prisma and the Guild inthis blog post.

• About
  • Highlights
  • Motivation
  • Supported languages
• Getting started
  • Try out a project initializer
  • Add to existing project
  • Documentation
• Addendum
  • Community
  • Project Status
  • Prior Art

• Schema-first Design in SDL to derive ideal types
• Type-safety Resolvers with precise signatures includingparent,args and return type
• DX Precise resolver types puts your editor intellisense to work
• Ecosystem Interop codegen suitable for Yoga 1 or Apollo Server and supportsprettier andgraphql-import out of the box

Programming in type-safe environments can contribute toward great confidence in your code's integrity.graphqlgen aims to leverage the GraphQL type system to make your resolvers completely type-safe. This is important because resolvers are the heart of any graphql service and yet the hardest to statically type due to their dynaminism.

• TypeScript
• Flow

Others under discussion:

• reason

1. Run initializer

   yarn create graphqlgen my-app# npm init graphqlgen my-appcd my-appyarn start# npm run start

2. Edit./my-app/src/schema.graphql to your heart's content.

3. Generate types:

   yarn graphqlgen

yarn add --dev graphqlgen# npm install --save-dev graphqlgen

Then you will have access to the cli (gg orgraphqlgen):

yarn -s gg --help# npm run gg --help

Usage: graphqlgen or ggOptions:  -i, --init     Initialize a graphqlgen.yml file  -v, --version  Show version number                                   [boolean]  -h, --help     Show help                                             [boolean]

gg depends on the presence of agraphqlgen.yml configlocated in the directory wheregg is invoked. Here is an example:

language:typescriptschema:./src/schema.graphqlcontext:./src/context.ts:Contextoutput:./src/generated/graphqlgen.tsmodels:files:    -./src/generated/prisma-client/index.ts

https://oss.prisma.io/graphqlgen

Join us at#graphqlgen in ourSlack group and if you have more fleshed out ideas, bug reports etc. create a Github issue:

• feature request
• bug report

graphqlgen is still in early stage development where breaking changes and tool design are a fluid matter. Feedback is deeply appreciated. You may feel comfortable giving it a try on production systems since there is no runtime aspect and hence quite safe to do so (save for a few optional default resolvers).

• gqlgen is the Golang equivalent ofgraphqlgen and served as a source of inspiration
• graphql-code-generator is a similar tool based on templates support both frontend & backend