Download the PHP package mll-lab/laravel-graphiql without Composer
On this page you can find all versions of the php package mll-lab/laravel-graphiql. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-graphiql
Laravel GraphiQL
A thin wrapper for serving the GraphiQL UI from Laravel
Please note: This is a UI for testing and exploring your schema and does not include a GraphQL server implementation. To serve a GraphQL API from Laravel, we recommend nuwave/lighthouse.
Installation
Install the package via composer:
Due to Laravel package discovery, this package will automatically register and is then ready to use without configuration.
If you are using Lumen, register the service provider in bootstrap/app.php
Upgrade Guide
When upgrading between major versions, consider UPGRADE.md
.
Configuration
By default, the GraphiQL UI is reachable at /graphiql
and assumes a running GraphQL endpoint at /graphql
.
To change those defaults, publish the configuration with the following command:
You will find the configuration file at config/graphiql.php
.
Lumen
If you are using Lumen, copy src/graphiql.php to config/graphiql.php
manually.
Then load the configuration in your boostrap/app.php
:
HTTPS behind proxy
If your application sits behind a proxy which resolves https, the generated URL for the endpoint might not use https://
.
This may cause the GraphiQL UI to not work by default.
To solve this, configure your TrustProxies
middleware to contain \Symfony\Component\HttpFoundation\Request::HEADER_X_FORWARDED_FOR
in $headers
.
Customization
To customize the GraphiQL UI even further, publish the view:
You can use that for all kinds of customization.
Change settings of the GraphiQL UI instance
Add extra props in the call to React.createElement(GraphiQL, ...)
in the published view.
Configure session authentication
Session-based authentication can be used with Laravel Sanctum.
If you use GraphQL through sessions and CSRF, add the following to the <head>
in the published view:
Modify the GraphiQL props as follows:
Make sure your route includes the web
middleware group in config/graphiql.php
:
Local assets
To serve the assets from your own server, download them with:
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 GraphiQL UI in production, you can disable it in the config file.
The easiest way is to set the environment variable GRAPHIQL_ENABLED=false
.
If you want to protect the route to the GraphiQL UI, you can add custom middleware in the config file.