README

Easily integrate GraphQL Voyager into your Laravel projects.

Please note: This is not a GraphQL Server implementation, only a UI for exploring your schema. For the server component we recommend nuwave/lighthouse.

Installation

composer require mll-lab/laravel-graphql-voyager

If you are using Lumen, register the service provider in bootstrap/app.php

$app->register(MLL\GraphQLVoyager\GraphQLVoyagerServiceProvider::class);

Configuration

By default, GraphQL Voyager is reachable at /graphql-voyager 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-voyager-config

You will find the configuration file at config/graphql-voyager.php.

If you are using Lumen, copy it into that location manually and load the configuration in your boostrap/app.php:

$app->configure('graphql-voyager');

Customization

To customize GraphQL Voyager even further, publish the view:

php artisan vendor:publish --tag=graphql-voyager-view

You can use that for all kinds of customization.

Change settings of the GraphQL Voyager instance

Check https://github.com/APIs-guru/graphql-voyager#properties for the allowed config options. You may change them in the published view where GraphQLVoyager.init() is called, for example:

    GraphQLVoyager.init(document.getElementById('voyager'), {
+       someOption: 'some-value',
    });

Local assets

If you want to serve the assets from your own server, you can download them with the command:

php artisan graphql-voyager: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 GraphQL Voyager in production, you can disable it in the config file. The easiest way is to set the environment variable GRAPHQL_VOYAGER_ENABLED=false.

To protect the route to GraphQL Voyager, add custom middleware in the config file.

mll-lab / laravel-graphql-voyager

Maintainers

Details