xkojimedia/laravel-altair-graphql

Easily integrate Altair GraphQL Client into your Laravel project

v0.2.0 2021-01-28 16:54 UTC

Requires

• php: >=7.1
• illuminate/console: 5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6 || ^7 || ^8
• illuminate/contracts: 5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6 || ^7 || ^8
• illuminate/support: 5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6 || ^7 || ^8

Requires (Dev)

• laravel/lumen-framework: 5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6 || ^7
• localheinz/composer-normalize: ^1.3

MIT

• Samuel Imolorhe

• laravel
• graphql
• graphiql
• altair-graphql

README

Easily integrate Altair GraphQL Client 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.

DISCLAIMER: This is a port of laravel-graphql-playground from @spawnia of mll-lab, but for Altair GraphQL Client.

Installation

composer require xkojimedia/laravel-altair-graphql

If you are using Laravel < 5.4, add the service provider to your config/app.php

'providers' => [
    // Other providers...
    XKojiMedia\AltairGraphQL\AltairGraphQLServiceProvider::class,
]

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

$app->register(XKojiMedia\AltairGraphQL\AltairGraphQLServiceProvider::class);

Configuration

By default, Altair is reachable at /altair and assumes a running GraphQL endpoint at /graphql.

To change the defaults, publish the configuration with the following command:

php artisan vendor:publish --provider="XKojiMedia\AltairGraphQL\AltairGraphQLServiceProvider" --tag=config

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

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

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

Customization

To customize Altair even further, publish the view:

php artisan vendor:publish --provider="XKojiMedia\AltairGraphQL\AltairGraphQLServiceProvider" --tag=views

You can use that for all kinds of customization.

Change settings of the Altair instance

Check https://github.com/imolorhe/altair#configuration-options for the allowed config options, for example:

<script>
  var altairOptions = {
    endpointURL: "{{url(config('altair-graphql.endpoint'))}}"
  };

  window.addEventListener("load", function() {
    AltairGraphQL.init(altairOptions);
  });
</script>

Configure session authentication

If you use GraphQL through sessions and CSRF, add the following to the body:

<script>window.__CSRF_TOKEN__ = "{{ csrf_token() }}";</script>

Modify the Altair config like so:

AltairGraphQL.init({
  endpointURL: "{{url(config('altair-graphql.endpoint'))}}",
+ initialPreRequestScript: "altair.helpers.setEnvironment('csrf_token', window.__CSRF_TOKEN__);",
+ initialHeaders: {
+   'X-CSRF-TOKEN': '{{ csrf_token }}'
+ }
})

Local assets

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

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

If you want to add custom middleware to protect the route to Altair GraphQL, you can add it in the configuration file.