laravel-graphiql - GitLite

KO | EN

gitlite — search

#javascript #typescript #llm #go #machine-learning #docker #nodejs #macos #awesome #kubernetes #awesome-list #vue #pytorch #ios

laravel-graphiql

(★ 71)

A thin wrapper for serving the GraphiQL UI from Laravel

File Explorer

Download Latest Version (.zip)

- settings.json
- - format.yml
  - validate.yml
- DownloadAssetsCommand.php
- graphiql.php
- GraphiQLAsset.php
- GraphiQLController.php
- GraphiQLServiceProvider.php
- routes.php
- DownloadAssetsCommandTest.php
- TestCase.php
- index.blade.php
.gitattributes
.gitignore
.php-cs-fixer.php
.pre-commit-config.yaml
CHANGELOG.md
composer.json
LICENSE
Makefile
phpstan.neon
phpunit.xml
README.md
UPGRADE.md

# Installation Guide

1. Get the code

git clone https://github.com/mll-lab/laravel-graphiql

Downloads the entire project code from GitHub to your computer.

cd laravel-graphiql

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer require mll-lab/laravel-graphiql

Type this command into your terminal and run it.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

3. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Laravel GraphiQL

A thin wrapper for serving [the GraphiQL UI](https://github.com/graphql/graphiql/tree/main/packages/graphiql) from Laravel

[![GitHub license](https://img.shields.io/github/license/mll-lab/laravel-graphiql.svg)](https://github.com/mll-lab/laravel-graphqil/blob/master/LICENSE)
[![Packagist](https://img.shields.io/packagist/v/mll-lab/laravel-graphiql.svg)](https://packagist.org/packages/mll-lab/laravel-graphqil)
[![Packagist](https://img.shields.io/packagist/dt/mll-lab/laravel-graphiql.svg)](https://packagist.org/packages/mll-lab/laravel-graphqil)

![Screenshot of GraphiQL with Doc Explorer Open](https://raw.githubusercontent.com/graphql/graphiql/main/packages/graphiql/resources/graphiql.png)

> **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](https://github.com/nuwave/lighthouse).

## Installation

Install the package via [composer](https://getcomposer.org):

```shell
composer require mll-lab/laravel-graphiql
```

Due to [Laravel package discovery](https://laravel.com/docs/packages#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`

```php
$app->register(MLL\GraphiQL\GraphiQLServiceProvider::class);
```

## Upgrade Guide

When upgrading between major versions, consider [`UPGRADE.md`](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:

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

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

### Lumen

If you are using Lumen, copy [src/graphiql.php](src/graphiql.php) to `config/graphiql.php` manually.
Then load the configuration in your `boostrap/app.php`:

```php
$app->configure('graphiql');
```

### 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:

```shell
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.

```js
React.createElement(GraphiQL, {
  ...,
  // See https://github.com/graphql/graphiql/tree/main/packages/graphiql#props for available settings
});
```

### Configure session authentication

Session-based authentication can be used with [Laravel Sanctum](https://laravel.com/docs/sanctum).
If you use GraphQL through sessions and CSRF, add the following to the `<head>` in the published view:

```diff
+<meta name="csrf-token" content="{{ csrf_token() }}">
```

Modify the GraphiQL props as follows:

```diff
const fetcher = GraphiQL.createFetcher({
    url: '{{ $url }}',
    subscriptionUrl: '{{ $subscriptionUrl }}',
+   headers: {
+       'X-CSRF-TOKEN': document.querySelector('meta[name="csrf-token"]').content,
+   },
});
```

Make sure your route includes the `web` middleware group in `config/graphiql.php`:

```diff
    'routes' => [
        '/graphiql' => [
            'name' => 'graphiql',
+           'middleware' => ['web']
        ],
    ],
```

## Local assets

To serve the assets from your own server, download them with:

```shell
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.