【週末Rails勉強会】GraphQLの使用法

ちょいちょい名前を耳にするが、いまいち流行っているのかどうなのか良く分からないGraphQL。良い機会なので触って見ることにしました。Railsにて基本的な使用法を手を動かしながら確認してみたいと思います。

環境

• rails 5.2.2.1
• ruby 2.6.1
• graphiql-rails 1.7.0
• graphql 1.9.3

GraphQL is 何？

• API向けのクエリ言語
• made by facebook
• エンドポイントが一つ
• 1リクエストで必要なものだけ取得、更新可能

公式の説明はこちら

RESTとどうちがう？

RESTの場合

• GET /users
• GET /users/:id
• POST /users
• PUT /users/:id
• DELETE /users/:id　など他多数

GraphQLの場合

• POST /graphql　これ一つのみ！！

例えばGraphQLでGET /users　する場合は

{
  users{ 
    name 
  }
}

すると

{
  "data": {
    "users": {
      "name": "田中太郎"
    }
  }
}

こんな形でJSONデータが返却される。

これには木之本桜ちゃんじゃなくても「ほぇ〜」って思わず言ってしまいますねw（良く分からない）では、実際にRailsで動かして確認してみましょう。

Railsへ導入

1. Gemfileに追加
   gem ‘graphql’
2. installコマンドを叩く
   $ bundle install
   $ rails g graphql:install

任意の情報を取得する

前提条件

ここでは ActivRecordのモデルとして Testが作成された状態にしている。
testsテーブルのカラムは以下のように設定した。
id(BIGINT)
title(VARCHER)
content(VARCHER)
created_at(DATETIME)
updated_at(DATETIME)

データを取得する前にGraphQL用にオブジェクトの作成を行う。

rails g graphql:object Test id:ID! title:String! content:String! createdAt:String! updatedAt:String!

module Types
  class TestType < Types::BaseObject
    field :id, ID, null: false
    field :title, String, null: false
    field :content, String, null: false
    field :createdAt, String, null: false
    field :updatedAt, String, null: false
  end
end

日付がStringなのは今は気にしないでください、後ほど説明しまう。

module Types
  class QueryType < Types::BaseObject
      argument :id, ID, required: true
    end
    def test(id:)
      Test.find(id)
    end
  end
end

fieldの型

クエリ叩いてみる

graphiqlにて叩く

Controllerにて叩く

query_string = "
{
  test(id: 1){
    title
    content
    createdAt
  }
}
    "

YourHogeSchema.execute(query_string)

公式サイト等

• GraphQL Ruby
• GraphQL