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 Laravel < 5.4, add the service provider to your config/app.php
'providers' => [
// Other providers...
MLL\\GraphQLPlayground\\GraphQLPlaygroundServiceProvider::class,
]
You may publish the configuration and/or the views:
php artisan vendor:publish --provider="MLL\GraphQLPlayground\GraphQLPlaygroundServiceProvider"
By default, the playground is reachable at /graphql-playground
It assumes a running GraphQL endpoint at /graphql
. You can enter another URL in the
UI or change the default setting in the configuration file.
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 add custom middleware to protect the route to the GraphQL playground, you can add it in the configuration file.