Easily integrate GraphiQL into your Laravel projects.
Please note: This a UI for testing and exploring your schema and does not include a GraphQL server implementation. To host GraphQL from Laravel, we recommend nuwave/lighthouse.
composer require mll-lab/laravel-graphiql
If you are using Lumen, register the service provider in bootstrap/app.php
$app->register(MLL\GraphiQL\GraphiQLServiceProvider::class);By default, the GraphiQL UI is reachable at /graphiql
and assumes a running GraphQL endpoint at /graphql.
To change the defaults, publish the configuration with the following command:
php artisan vendor:publish --tag=graphiql-config
You will find the configuration file at config/graphiql.php.
If you are using Lumen, copy it into that location manually and load the configuration
in your boostrap/app.php:
$app->configure('graphiql');If your application sits behind a proxy which resolves https, the generated URL for the endpoint
might not use https://, thus causing the GraphiQL UI to not work by default. In order to solve
this, configure your TrustProxies middleware to contain \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_FOR
in $headers.
To customize the GraphiQL UI even further, publish the view:
php artisan vendor:publish --tag=graphiql-view
You can use that for all kinds of customization.
Add extra settings in the call to React.createElement(GraphiQL, {}) in the published view:
React.createElement(GraphiQL, {
fetcher: GraphiQL.createFetcher({
url: '{{ url(config('graphiql.endpoint')) }}',
subscriptionUrl: '{{ config('graphiql.subscription-endpoint') }}',
}),
// See https://github.com/graphql/graphiql/tree/main/packages/graphiql#props 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 GraphQL UI config:
React.createElement(GraphiQL, {
fetcher: GraphiQL.createFetcher({
url: '{{ url(config('graphiql.endpoint')) }}',
subscriptionUrl: '{{ config('graphiql.subscription-endpoint') }}',
}),
+ defaultHeaders: JSON.stringify({
+ 'X-CSRF-TOKEN': document.querySelector('meta[name="csrf-token"]').content,
+ }),
})Make sure your route includes the web middleware group in config/graphiql.php:
'route' => [
'uri' => '/graphiql',
'name' => 'graphiql',
+ 'middleware' => ['web']
]To serve the assets from your own server, download them with:
php artisan graphiql: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 GraphiQL UI in production, you can disable it in the config file.
The easiest way is to set the environment variable GRAPHIQL_ENABLED=false.
If you want to protect the route to the GraphiQL UI, you can add custom middleware in the config file.