Download the PHP package xkojimedia/laravel-altair-graphql without Composer
On this page you can find all versions of the php package xkojimedia/laravel-altair-graphql. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download xkojimedia/laravel-altair-graphql
More information about xkojimedia/laravel-altair-graphql
Files in xkojimedia/laravel-altair-graphql
Package laravel-altair-graphql
Short Description Easily integrate Altair GraphQL Client into your Laravel project
License MIT
Informations about the package laravel-altair-graphql
Laravel Altair GraphQL
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
If you are using Lumen, register the service provider in bootstrap/app.php
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
:
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:
Configure session authentication
If you use GraphQL through sessions and CSRF, add the following to the body:
Modify the Altair config like so:
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.
All versions of laravel-altair-graphql with dependencies
illuminate/console Version 5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6 || ^7 || ^8
illuminate/contracts Version 5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6 || ^7 || ^8
illuminate/support Version 5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6 || ^7 || ^8