A Ruby implementation of GraphQL.
Install from RubyGems by adding it to your Gemfile
, then bundling.
# Gemfile
gem 'graphql'
$ bundle install
# Declare a type...
PostType = GraphQL::ObjectType.define do
name "Post"
description "A blog post"
field :id, !types.ID
field :title, !types.String
field :body, !types.String
field :comments, types[!CommentType]
end
# ...and a query root
QueryType = GraphQL::ObjectType.define do
name "Query"
description "The query root of this schema"
field :post do
type PostType
argument :id, !types.ID
resolve -> (obj, args, ctx) { Post.find(args["id"]) }
end
end
# Then create your schema
Schema = GraphQL::Schema.new(
query: QueryType,
max_depth: 8,
)
Execute GraphQL queries on a given schema, from a query string.
result_hash = Schema.execute(query_string)
# {
# "data" => {
# "post" => {
# "id" => 1,
# "title" => "GraphQL is nice"
# }
# }
# }
If you're building a backend for Relay, you'll need:
- A JSON dump of the schema, which you can get by sending
GraphQL::Introspection::INTROSPECTION_QUERY
- Relay-specific helpers for GraphQL like Connections, node fields, and global ids. Here's one example of those:
graphql-relay
- Implement the GraphQL spec & support a Relay front end
- Provide idiomatic, plain-Ruby API with similarities to reference implementation where possible
- Support Ruby on Rails and Relay
- Say hi & ask questions in the #ruby channel on Slack or on Twitter!
- Report bugs by posting a description, full stack trace, and all relevant code in a GitHub issue.
- Features & patches are welcome! Consider discussing it in an issue or in the #ruby channel on Slack to make sure we're on the same page.
- Run the tests with
rake test
or start up guard withbundle exec guard
.
graphql-ruby
+ Rails demo (src / heroku)graphql-batch
, a batched query execution strategy- Example Relay support in Ruby
graphql-libgraphqlparser
, bindings to libgraphqlparser, a C-level parser.
- Building a blog in GraphQL and Relay on Rails Introduction, Part 1, Part 2
- https://medium.com/@khor/relay-facebook-on-rails-8b4af2057152
- https://blog.jacobwgillespie.com/from-rest-to-graphql-b4e95e94c26b#.4cjtklrwt
- http://mgiroux.me/2015/getting-started-with-rails-graphql-relay/
- http://mgiroux.me/2015/uploading-files-using-relay-with-rails/
- Type lookup should be by type name (to support reloaded constants in Rails code)
- Add a complexity validator (reject queries if they're too big)
- Add docs for shared behaviors & DRY code
- Revamp the fixture Schema to be more useful (better names, more extensible)
- Revisit error handling &
debug:
option - Subscriptions
- This is a good chance to make an
Operation
abstraction of whichquery
,mutation
andsubscription
are members - For a subscription,
graphql
would send an outbound message to the system (allow the host application to manage its own subscriptions via Pusher, ActionCable, whatever)
- This is a good chance to make an