Class: Graphql::Generators::InstallGenerator
- Inherits:
-
Rails::Generators::Base
- Object
- Rails::Generators::Base
- Graphql::Generators::InstallGenerator
- Includes:
- Core
- Defined in:
- lib/generators/graphql/install_generator.rb
Overview
Add GraphQL to a Rails app with rails g graphql:install
.
Setup a folder structure for GraphQL:
- app/
- graphql/
- resolvers/
- types/
- base_argument.rb
- base_field.rb
- base_enum.rb
- base_input_object.rb
- base_interface.rb
- base_object.rb
- base_scalar.rb
- base_union.rb
- query_type.rb
- loaders/
- mutations/
- base_mutation.rb
- {app_name}_schema.rb
(Add .gitkeep
s by default, support --skip-keeps
)
Add a controller for serving GraphQL queries:
app/controllers/graphql_controller.rb
Add a route for that controller:
ruby
# config/routes.rb
post "/graphql", to: "graphql#execute"
Accept a --relay
option which adds
The root node(id: ID!)
field.
Accept a --batch
option which adds GraphQL::Batch
setup.
Use --no-graphiql
to skip graphiql-rails
installation.
TODO: also add base classes
Instance Method Summary collapse
Methods included from Core
#create_dir, #create_mutation_root_type, #insert_root_type, #schema_file_path
Instance Method Details
#create_folder_structure ⇒ Object
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/generators/graphql/install_generator.rb', line 100 def create_folder_structure create_dir("#{[:directory]}/types") template("schema.erb", schema_file_path) ["base_object", "base_argument", "base_field", "base_enum", "base_input_object", "base_interface", "base_scalar", "base_union"].each do |base_type| template("#{base_type}.erb", "#{[:directory]}/types/#{base_type}.rb") end # Note: You can't have a schema without the query type, otherwise introspection breaks template("query_type.erb", "#{[:directory]}/types/query_type.rb") insert_root_type('query', 'QueryType') create_mutation_root_type unless .skip_mutation_root_type? template("graphql_controller.erb", "app/controllers/graphql_controller.rb") route('post "/graphql", to: "graphql#execute"') if [:batch] gem("graphql-batch") create_dir("#{[:directory]}/loaders") end if .api? say("Skipped graphiql, as this rails project is API only") say(" You may wish to use GraphiQL.app for development: https://github.com/skevy/graphiql-app") elsif ![:skip_graphiql] gem("graphiql-rails", group: :development) # This is a little cheat just to get cleaner shell output: log :route, 'graphiql-rails' shell.mute do # Rails 5.2 has better support for `route`? if Rails::VERSION::STRING > "5.2" route <<-RUBY if Rails.env.development? mount GraphiQL::Rails::Engine, at: "/graphiql", graphql_path: "/graphql" end RUBY else route <<-RUBY if Rails.env.development? mount GraphiQL::Rails::Engine, at: "/graphiql", graphql_path: "/graphql" end RUBY end end end if [:playground] gem("graphql_playground-rails", group: :development) log :route, 'graphql_playground-rails' shell.mute do if Rails::VERSION::STRING > "5.2" route <<-RUBY if Rails.env.development? mount GraphqlPlayground::Rails::Engine, at: "/playground", graphql_path: "/graphql" end RUBY else route <<-RUBY if Rails.env.development? mount GraphqlPlayground::Rails::Engine, at: "/playground", graphql_path: "/graphql" end RUBY end end end if gemfile_modified? say "Gemfile has been modified, make sure you `bundle install`" end end |