英语翻译的不好，我把基本的介绍和操作步骤整理了。项目中一共有 4 个例子。分别放在四个 Tags 中。有查询、修改、嵌套数据查询，N+1 问题的解决。

介绍

GraphQL 是一个接口搜索语言，由 Feacbook 在 2015 年开源的。

GraphQL 就是可以让客户端查询他们确切需要的数据，服务器并不会有过多的返回。

一个 GraphQL 请求分为 查询 (读操作)，或 变化 (mutation，写操作), 请求是一个简单的字符串 (类似 json 的格式)，GraphQL 服务能解析，执行，并返回指定的数据。

GraphQL 主要特点

• 在请求中，只返回客户端需要的数据

• 在一次请求中，返回更多资源。

• 用类型系统描述什么是可得的

• 可维护性 - 不需要考虑版本的迭代 API

GraphQL 查询例子

一个查询用户的例子

{
  user(id: 1) {
    firstName,
    lastName,
    email
  }
}

结果

{
  "data": {
    "user": {
      "firstName": "Shaiju",
      "lastName": "E",
      "email": "[email protected]"
     }
   }
}

在 Rails 中搭建 GraphQL 服务

添加 Gem

# Gemfile
gem "graphql"
gem 'graphiql-rails', group: :development

graphiql-rails 是一个 graphql 的 Web 请求页面，使用 graphiql 打包成一个 Gem.

然后执行 bundle install

生成 GraphQL 文件

rails g graphql:install

生成：

• 创建一个文件夹 app/graphql/
• 创建一个默认的 schema
• 添加一个查询类型定义
• 添加一个查询路由

运行查看

rails server
open localhost:3000/graphiql

增加一个文章查询 (article)

增加一个文章类型 ArticleType

ArticleType = GraphQL::ObjectType.define do
  name "Article"
  field :id, types.Int
  field :title, types.String
  field :body, types.String
  field :comments, types[CommentType]
end

然后建立一个查询模式

路径 app/graphql/types/query_type.rb

QueryType = GraphQL::ObjectType.define do
  name "Query"
  description "一个根查询的 schema"

  field :acticle do
    type ArticleType
    argument :id, !types.ID
    description "Find a Article by ID"
    resolve ->(obj, args, ctx) { Article.find_by_id(args["id"]) }
  end
end

schema 进入文件

路径 app/graphql/graphq_api_schema.rb

GraphqApiSchema = GraphQL::Schema.define do
  query(Types::QueryType)
end

在 application.rb 中加载 graphql 文件

config.autoload_paths << Rails.root.join('app/graphql')
config.autoload_paths << Rails.root.join('app/graphql/types')

下面启动 rails, 在 localhost:3000/graphiql 查询文章

query {
  acticle(id: 1){
    title
  }
}

结果

{
  "data": {
    "acticle": {
      "title": "A GraphQL Server"
    }
  }
}

也可以通过 execute 命令查询

query_string = "
{
  acticle(id: 1) {
    id
    title
  }
}"
result_hash = GraphqApiSchema.execute(query_string)

# output:
# {
#   "data" => {
#     "acticle" => {
#        "id" => 1,
#        "title" => "A GraphQL Server"
#     }
#   }
# }

Resource

http://graphql-ruby.org/

https://github.com/xfstart07/graphql-api

http://tech.eshaiju.in/blog/2017/05/06/a-graphql-server-implementation-ruby-on-rails/