Quickstart
Get up and running with your first GraphQL query in minutes
Installation
Add Rails GraphQL to your Rails application
Architecture
Understand how Rails GraphQL integrates with Rails
Core Concepts
Deep dive into schemas, types, and fields
Why Rails GraphQL?
Rails GraphQL brings GraphQL to Rails in a way that feels natural to Rails developers. Instead of fighting against Rails conventions, it embraces them.Native Rails integration
Built from the ground up to work seamlessly with Rails patterns and conventions. The framework feels like a natural extension of Rails, not a foreign library bolted on.Outstanding performance
Features a custom C-based parser written from scratch using Ruby’s C-API, delivering exceptional performance for parsing GraphQL queries.Ruby-first DSL
Define your GraphQL schemas using the most Ruby-like DSL available. No need to learn a new syntax - if you know Rails, you’ll feel right at home.ActiveRecord integration
Direct connection with ActiveRecord through the Sources feature. Automatically generate GraphQL types from your models with full support for PostgreSQL, MySQL, and SQLite.Multiple schemas support
Run one or multiple GraphQL schemas under the same application or across multiple engines, with proper namespace isolation.Real-time subscriptions
Built-in subscription support with ActionCable provider, making it easy to add real-time features to your GraphQL API.Key features
GraphQL Parser
Custom C-based parser supporting the October 2021 spec
Schemas
One or multiple schemas under the same application
Queries & Mutations
3 different ways to define queries and mutations
Subscriptions
Real-time updates with ActionCable provider
Extended Scalars
All spec scalars plus: any, bigint, binary, date, date_time, decimal, json, and time
Sources
Bridge between classes and GraphQL types with full ActiveRecord support
Type Map
Centralized registry where all types are stored and resolved
Directives
4 built-in directives with event-driven interface for custom directives
GraphQL spec compliance
Rails GraphQL supports the October 2021 GraphQL specification, providing:- Full introspection support with proper descriptions
- Standard directives:
@deprecated,@skip,@include, and@specifiedBy - All GraphQL types: Objects, Interfaces, Unions, Enums, Inputs, and Scalars
- Complete validation and error handling
The framework’s spec version is available at
Rails::GraphQL::SPEC_VERSIONNext steps
Ready to get started? Follow our quickstart guide to create your first GraphQL query.Get Started
Build your first GraphQL API in 3 simple steps