Generators

If you’re using GraphQL with Ruby on Rails, you can use generators to:

• setup GraphQL, including GraphiQL, GraphQL::Batch, and Relay
• scaffold types
• scaffold Relay mutations
• scaffold GraphQL::Batch loaders

graphql:install

You can add GraphQL to a Rails app with graphql:install:

rails generate graphql:install

This will:

• Set up a folder structure in app/graphql/
• Add schema definition
• Add base type classes
• Add a Query type definition
• Add a Mutation type definition with a base mutation class
• Add a route and controller for executing queries
• Install graphiql-rails

After installing you can see your new schema by:

• bundle install
• rails server
• Open localhost:3000/graphiql

Options

• --relay will add Relay-specific code to your schema
• --batch will add GraphQL::Batch to your gemfile and include the setup in your schema
• --no-graphiql will exclude graphiql-rails from the setup
• --schema=MySchemaName will be used for naming the schema (default is #{app_name}Schema)

Scaffolding Types

Several generators will add GraphQL types to your project. Run them with -h to see the options:

• rails g graphql:object
• rails g graphql:interface
• rails g graphql:union
• rails g graphql:enum
• rails g graphql:scalar

Scaffolding Mutations

You can prepare a Relay Classic mutation with

rails g graphql:mutation #{mutation_name}

Scaffolding Loaders

You can prepare a GraphQL::Batch loader with

rails g graphql:loader