インストール

ここでは、プロジェクトにLighthouseをインストールする方法について説明します。

composer経由でインストールする

composer require nuwave/lighthouse

デフォルトのスキーマをpublishする

Lighthouseには、すぐに使えるようデフォルトのスキーマが含まれています。publishするには以下のartisanコマンドを使用してください。

php artisan vendor:publish --tag=lighthouse-schema

Lumen

サービスプロバイダをbootstrap/app.phpに登録します:

$app->register(\Nuwave\Lighthouse\LighthouseServiceProvider::class);

Lighthouseが提供する多くの機能は、複数のサービスプロバイダに分かれています。Lumenはauto-discoveryをサポートしていないので、どの機能を使いたいかによって個別の登録が必要です。Lighthouseにおけるcomposer.jsonを確認してください。セクションextra.laravel.providersに、デフォルトのサービスプロバイダが含まれています。

IDE サポート

LighthouseはSDL、スキーマディレクティブを多用しています。IDEで作業しやすくするためにartisanコマンドを使って定義ファイルを生成することができます。

php artisan lighthouse:ide-helper

上記のコマンドはhaydenpierce/class-finderを必要とします。下記のコマンドを実行してインストールしてください。

composer require --dev haydenpierce/class-finder

以下のプラグインを推奨します。

IDE	Plugin
PhpStorm	https://plugins.jetbrains.com/plugin/8097-js-graphql

GraphQL DevToolsのインストール

GraphQLに関する素晴らしいツールを利用するために、GraphQL Playgroundをインストールすることをお勧めします。

composer require mll-lab/laravel-graphql-playground

インストール後、ブラウザから/graphql-playgroundにアクセスし、試してみてください。

Lighthouseでは任意のGraphQLクライアントを使用することができます。クライアントではconfigで指定したURLを指定してください。デフォルトではエンドポイントは/graphqlです。