Chap2 graphql-ruby gem Setup

Todo in this chapter

  • Setup graphql-ruby
  • Setup graphiql-rails

https://graphql-ruby.org/getting_started​

​

Step1. Install graphql-ruby gem

Gemfile 

gem "graphql"

terminal 

bundle
rails g graphql:install
​
​
Running via Spring preloader in process 49714
      create  app/graphql/types
      create  app/graphql/types/.keep
      create  app/graphql/rails_api_graphql_crud_tuto_schema.rb
      create  app/graphql/types/base_object.rb
      create  app/graphql/types/base_enum.rb
      create  app/graphql/types/base_input_object.rb
      create  app/graphql/types/base_interface.rb
      create  app/graphql/types/base_scalar.rb
      create  app/graphql/types/base_union.rb
      create  app/graphql/types/query_type.rb
add_root_type  query
      create  app/graphql/mutations
      create  app/graphql/mutations/.keep
      create  app/graphql/types/mutation_type.rb
add_root_type  mutation
      create  app/controllers/graphql_controller.rb
       route  post "/graphql", to: "graphql#execute"
Skipped graphiql, as this rails project is API only
  You may wish to use GraphiQL.app for development: https://github.com/skevy/graphiql-app
​

Step2. Install graphiql-rails gem

  • Graphiql is tool like below.
  • We will use it later. ​02 ​

Gemfile 

gem "graphiql-rails"

  • I want to use subdomain for api, so...

config/routes.rb 

Rails.application.routes.draw do
  constraints subdomain: 'api' do
    if Rails.env.development?
      mount GraphiQL::Rails::Engine, at: "/graphiql", graphql_path: "/graphql"
    end
​
    post "/graphql", to: "graphql#execute"
  end
end
​

application.rb 

# uncomment out this line
require "sprockets/railtie"

  • This is only needed if you use subdomain.

config/environments/development.rb 

Rails.application.configure do
  ...
  # https://github.com/rails/rails/issues/12438
  # https://gist.github.com/indiesquidge/b836647f851179589765
  config.action_dispatch.tld_length = 0
end
​

Step3. Check it