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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of mll-lab/laravel-graphiql

Informations about the package laravel-graphiql

Laravel GraphiQL

A thin wrapper for serving the GraphiQL UI from Laravel

GitHub license Packagist Packagist

Screenshot of GraphiQL with Doc Explorer Open

Please note: This 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:

composer require mll-lab/laravel-graphiql

Due to Laravel package discovery, this package will automatically register and is 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 the defaults, publish the configuration with the following command:

php artisan vendor:publish --tag=graphiql-config

You will find the configuration file at config/graphiql.php.

Lumen

If you are using Lumen, copy it into that location manually and 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://, thus causing the GraphiQL UI to not work by default. In order 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:

php artisan vendor:publish --tag=graphiql-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:

php artisan graphiql: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 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.

All versions of laravel-graphiql with dependencies

PHP Build Version
Package Version
Requires php Version ^8
illuminate/console Version ^9 || ^10 || ^11 || ^12
illuminate/contracts Version ^9 || ^10 || ^11 || ^12
illuminate/support Version ^9 || ^10 || ^11 || ^12
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package mll-lab/laravel-graphiql contains the following files

Loading the files please wait ....