{"id":37464,"date":"2023-11-14T06:44:09","date_gmt":"2023-11-14T06:44:09","guid":{"rendered":"https:\/\/www.railscarma.com\/?p=37464"},"modified":"2023-11-14T07:51:28","modified_gmt":"2023-11-14T07:51:28","slug":"building-graphql-api-in-rails-a-quick-setup-guide","status":"publish","type":"post","link":"https:\/\/www.railscarma.com\/it\/blog\/building-graphql-api-in-rails-a-quick-setup-guide\/","title":{"rendered":"Creazione dell'API GraphQL in Rails: una guida di installazione rapida"},"content":{"rendered":"
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

GraphQL, a modern query language for APIs, paired with Ruby on Rails, offers a powerful combination for streamlined API development. In this quick guide, we’ll walk through the essential steps to set up a GraphQL API in a Ruby on Rails application, providing you with a solid foundation for efficient and flexible web development.<\/p>\n

Step 1: Create a new Rails project<\/span><\/h3>\n

bash<\/span><\/p>\n

rails new graphql_example<\/span>
<\/p>\n
cd graphql_example<\/span><\/p><\/pre>\n
Step 2: Add necessary gems to your Gemfile<\/span><\/h3>\n
Add the following gems to your <\/span>Gemfile<\/span>:<\/span><\/p>\n
rubino<\/span><\/p>\n
gem 'graphql'<\/span>
<\/p>\n
gem 'graphiql-rails', group: :development<\/span><\/p><\/pre>\n
Correre <\/span>installazione del pacchetto<\/span> to install the new gems.<\/span><\/p>\n
Step 3: Create a GraphQL schema<\/span><\/h3>\n
Create a file named <\/span>app\/graphql\/types\/query_type.rb<\/span>:<\/span><\/p>\n
rubino<\/span><\/p>\n
# app\/graphql\/types\/query_type.rb<\/span>
<\/p>\n
Types::QueryType = GraphQL::ObjectType.define do<\/span><\/p>\n
 name 'Query'<\/span><\/p>\n
 description 'The root query type'<\/span><\/p>\n
 field :hello do<\/span><\/p>\n
 type types.String<\/span><\/p>\n
 description 'An example field'<\/span><\/p>\n
 resolve ->(_obj, _args, _ctx) { 'Hello, GraphQL!' }<\/span><\/p>\n
 FINE<\/span><\/p>\n
FINE<\/span><\/p><\/pre>\n
Step 4: Create a GraphQL controller<\/span><\/h3>\n
Generate a controller to handle GraphQL queries:<\/span><\/p>\n
bash<\/span><\/p>\n
rails generate controller graphql execute<\/span><\/pre>\n
Replace the content of <\/span>app\/controllers\/graphql_controller.rb<\/span> with the following:<\/span><\/p>\n
rubino<\/span><\/p>\n
# app\/controllers\/graphql_controller.rb<\/span>
<\/p>\n
class GraphqlController < ApplicationController<\/span><\/p>\n
 def execute<\/span><\/p>\n
 variables = ensure_hash(params[:variables])<\/span><\/p>\n
 query = params[:query]<\/span><\/p>\n
 operation_name = params[:operationName]<\/span><\/p>\n
 context = {<\/span><\/p>\n
 # Add any necessary context values here, such as current_user or session<\/span><\/p>\n
 }<\/span><\/p>\n
 result = Schema.execute(query, variables: variables, context: context, operation_name: operation_name)<\/span><\/p>\n
 render json: result<\/span><\/p>\n
 FINE<\/span><\/p>\n
 privato<\/span><\/p>\n
 def ensure_hash(variables)<\/span><\/p>\n
 case variables<\/span><\/p>\n
 when String<\/span><\/p>\n
 JSON.parse(variables) || {}<\/span><\/p>\n
 when Hash<\/span><\/p>\n
 variables<\/span><\/p>\n
 when nil<\/span><\/p>\n
 {}<\/span><\/p>\n
 altro<\/span><\/p>\n
 raise ArgumentError, \"Invalid variables: #{variables}\"<\/span><\/p>\n
 FINE<\/span><\/p>\n
 FINE<\/span><\/p>\n
FINE<\/span><\/p><\/pre>\n
Step 5: Create the GraphQL schema<\/span><\/h3>\n
Create a file named <\/span>app\/graphql\/schema.rb<\/span>:<\/span><\/p>\n
rubino<\/span><\/p>\n
# app\/graphql\/schema.rb<\/span>
<\/p>\n
Schema = GraphQL::Schema.define do<\/span><\/p>\n
 query(Types::QueryType)<\/span><\/p>\n
 # Add mutation types if needed<\/span><\/p>\n
FINE<\/span><\/p><\/pre>\n
Step 6: Configure routes<\/span><\/h3>\n
Update your <\/span>config\/routes.rb<\/span> to include the GraphQL endpoint:<\/span><\/p>\n
rubino<\/span><\/p>\n
# config\/routes.rb<\/span>
<\/p>\n
Rails.application.routes.draw lo fa<\/span><\/p>\n
 post '\/graphql', to: 'graphql#execute'<\/span><\/p>\n
 if Rails.env.development?<\/span><\/p>\n
 mount GraphiQL::Rails::Engine, at: '\/graphiql', graphql_path: '\/graphql'<\/span><\/p>\n
 FINE<\/span><\/p>\n
FINE<\/span><\/p><\/pre>\n
Step 7: Run your Rails server<\/span><\/h3>\n
bash<\/span><\/p>\n
rails s<\/span><\/pre>\n
Visit <\/span>http:\/\/localhost:3000\/graphiql<\/span> in your browser to use GraphiQL, an in-browser IDE for exploring GraphQL.<\/span><\/p>\n
In the GraphiQL interface, you can enter a query like:<\/span><\/p>\n
graphql<\/span><\/p>\n
{<\/span>
<\/p>\n
 hello<\/span><\/p>\n
}<\/span><\/p><\/pre>\n
And you should receive a response:<\/span><\/p>\n
json<\/span><\/p>\n
{<\/span>
<\/p>\n
 \"data\": {<\/span><\/p>\n
 \"hello\": \"Hello, GraphQL!\"<\/span><\/p>\n
 }<\/span><\/p>\n
}<\/span><\/p><\/pre>\n
This is a simple example, but you can expand your GraphQL schema with more types and mutations to suit your application’s needs.<\/span><\/p>\n
Conclusione<\/strong><\/h2>\n
By following this quick setup guide, you’ll be well-equipped to integrate GraphQL into your Ruby on Rails projects seamlessly. Harness the power of GraphQL to create APIs that cater to your application’s specific needs while providing an excellent developer and user experience. Get ready to elevate your API development game with the simplicity and flexibility of GraphQL in Ruby on Rails. Elevate your company’s digital presence with top-tier Ruby on Rails developers<\/a> from RailsCarma<\/a>. Our seasoned professionals bring a wealth of experience and innovation to the table, ensuring your projects are not only executed seamlessly but exceed industry standards.<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t<\/div>\n\t\t  
\r\n        
Articoli correlati<\/div>\r\n    
\r\n\r\n            
\r\n            
\r\n    \r\n\r\n      \"Gemma\r\n\r\n    <\/a>\r\n  <\/div>\r\n\r\n  \r\n        Cos'\u00e8 e come funziona Offliberty Ruby Gem  <\/a>\r\n\r\n        <\/div>\r\n              
\r\n            
\r\n    \r\n\r\n      \"Metodo\r\n\r\n    <\/a>\r\n  <\/div>\r\n\r\n  \r\n        Metodo Rails link_to: Guida completa con esempi  <\/a>\r\n\r\n        <\/div>\r\n              
\r\n            
\r\n    \r\n\r\n      \"Costruire\r\n\r\n    <\/a>\r\n  <\/div>\r\n\r\n  \r\n        Come costruire una piattaforma SaaS scalabile usando Ruby on Rails  <\/a>\r\n\r\n        <\/div>\r\n              
\r\n            
\r\n    \r\n\r\n      \"Ruby\r\n\r\n    <\/a>\r\n  <\/div>\r\n\r\n  \r\n        Ruby Regex Match Guide (2026) with Examples  <\/a>\r\n\r\n        <\/div>\r\n      \r\n  <\/div>\r\n\r\n