graphql-rubyのGeneratorsを翻訳してみる

こんにちは!kossyです!



さて、今回はgraphql-rubyの公式ドキュメント翻訳第2弾として、
generatorsの翻訳をしてみようかと思います。



偉大なる本家リポジトリはこちら




ジェネレーター

Ruby on RailsでGraphQLを使用している場合は、ジェネレーターを使用して以下のことが可能です。

GraphiQLGraphQL :: BatchRelayを含むGraphQLをセットアップすること
タイプの雛形生成
Relayミューテーションの雛形生成
GraphQL::Batchローダーの雛形生成

graphql:install

graphql:installを使用して、GraphQLをRailsアプリに追加できます。

rails generate graphql:install

これで、
・app / graphql /でフォルダ作成
スキーマ定義を追加する
・基本型クラスを追加する
・クエリタイプ定義を追加する
・基本ミューテーションクラスを使用してミューテーションタイプ定義を追加します
・クエリを実行するためのルートとコントローラーを追加します
・graphiql-railsをインストールする

インストール後、次の方法で新しいスキーマを確認できます。

・bundle install
rails server
localhost:3000/graphiql にアクセスする

Options

・--relay は、Relay固有のコードをスキーマに追加します
・--batch はGraphQL :: Batchをgemfileに追加し、スキーマにセットアップを含めます
・--playground はgraphql_playgroundが含まれます-セットアップにrails(/ playgroundにマウントされています)
・--no-graphiql はgraphiql-railsをセットアップから除外します
・--schema = MySchemaName は、スキーマ命名に使用されます(デフォルトは#{app_name} Schema)

Scaffolding Types

いくつかのジェネレーターがGraphQLタイプをプロジェクトに追加します。 -hを指定して実行し、オプションを確認します。

rails g graphql:object
rails g graphql:interface
rails g graphql:union
rails g graphql:enum
rails g graphql:scalar

Scaffolding Mutations

Relay Classic Mutation を準備することができます。

rails g graphql:mutation #{mutation_name}

Scaffolding Loaders

GraphQL :: Batchローダーは次のように準備できます。

rails g graphql:loader