Easily integrate GraphQL Playground into your Laravel projects.
Please note: This is not a GraphQL Server implementation, only a UI for testing and exploring your schema. For the server component we recommend nuwave/lighthouse.
composer require mll-lab/laravel-graphql-playground
If you are using Lumen, register the service provider in bootstrap/app.php
$app->register(MLL\GraphQLPlayground\GraphQLPlaygroundServiceProvider::class);By default, the playground is reachable at /graphql-playground
and assumes a running GraphQL endpoint at /graphql.
To change the defaults, publish the configuration with the following command:
php artisan vendor:publish --tag=graphql-playground-config
You will find the configuration file at config/graphql-playground.php.
If you are using Lumen, copy it into that location manually and load the configuration
in your boostrap/app.php:
$app->configure('graphql-playground');If your application sits behind a proxy which resolves https, the generated URL for the endpoint
will not be using https://, thus causing the Playground to not work by default. In order to solve
this, add the following to the boot() method of a service provider:
if (! $this->app->isLocal()) {
\Illuminate\Support\Facades\URL::forceScheme('https');
}To customize the Playground even further, publish the view:
php artisan vendor:publish --tag=graphql-playground-view
You can use that for all kinds of customization.
Add extra settings in the call to GraphQLPlayground.init in the published view:
GraphQLPlayground.init(document.getElementById('root'), {
endpoint: "{{ url(config('graphql-playground.endpoint')) }}",
subscriptionEndpoint: "{{ config('graphql-playground.subscriptionEndpoint') }}",
// See https://github.com/graphql/graphql-playground#properties for available settings
})Session based authentication can be used with Laravel Sanctum.
If you use GraphQL through sessions and CSRF, add the following to the <head> in the published view:
<meta name="csrf-token" content="{{ csrf_token() }}">Modify the Playground config:
GraphQLPlayground.init(document.getElementById('root'), {
endpoint: "{{ url(config('graphql-playground.endpoint')) }}",
subscriptionEndpoint: "{{ config('graphql-playground.subscriptionEndpoint') }}",
+ settings: {
+ 'request.credentials': 'same-origin',
+ },
+ headers: {
+ 'X-CSRF-TOKEN': document.querySelector('meta[name="csrf-token"]').content
+ }
})Make sure your route includes the web middleware group in config/graphql-playground.php:
'route' => [
'uri' => '/graphql-playground',
'name' => 'graphql-playground',
+ 'middleware' => ['web']
]If you want to serve the assets from your own server, you can download them with the command
php artisan graphql-playground:download-assets
This puts the necessary CSS, JS and Favicon into your public directory. If you have
the assets downloaded, they will be used instead of the online version from the CDN.
If you do not want to enable the GraphQL playground in production, you can disable it in the config file.
The easiest way is to set the environment variable GRAPHQL_PLAYGROUND_ENABLED=false.
If you want to protect the route to the GraphQL playground, you can add custom middleware in the config file.