Easily integrate GraphQL Playground into your Laravel project
Branch: master
Clone or download
Latest commit 2972946 Oct 20, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config Apply fixes from StyleCI Sep 28, 2018
src Apply fixes from StyleCI Sep 28, 2018
views Add option to download assets to serve them locally (#8) Aug 20, 2018
.gitignore Use php-cs-fixer Jun 15, 2018
.php_cs.dist Initial commit Jun 15, 2018
LICENSE Initial commit Jun 15, 2018
README.md Improve phrasing Oct 20, 2018
composer.json 5.7 support (#7) Aug 15, 2018

README.md

Laravel GraphQL Playground

Easily integrate GraphQL Playground into your Laravel projects.

GitHub license Packagist Packagist StyleCI

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.

Installation

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"

Usage

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.

Local assets

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.

Security

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.