Weave Code
Laravel Graphiql Laravel Package
mll-lab/laravel-graphiql
Adds a ready-to-use GraphiQL interface to Laravel applications, giving developers an in-browser IDE to explore GraphQL schemas, run queries and mutations, and inspect results. Published config and routes make it easy to point GraphiQL at your GraphQL endpoint.
Easily integrate GraphiQL into your Laravel project
Frequently asked questions about Laravel Graphiql
- What is mll-lab/laravel-graphiql used for?
- It adds an in-browser GraphiQL IDE to a Laravel application so you can explore your GraphQL schema, write queries and mutations with autocompletion and syntax highlighting, and inspect responses without a separate frontend. It is a developer-facing UI layer that points at your GraphQL endpoint and integrates cleanly with Lighthouse.
- How do I install mll-lab/laravel-graphiql in a Laravel app?
- Run composer require mll-lab/laravel-graphiql, optionally publish the config with php artisan vendor:publish, and set your GraphQL endpoint URL. Then open the route the package registers. There are no migrations, queues, or scheduled jobs involved.
- How do I change the GraphiQL route path or GraphQL endpoint URL?
- Publish the config file and edit the endpoint URL and route path keys in config/graphiql.php, then visit the route in your browser. The package registers a configurable route through its service provider, so changing the path or pointing at a different GraphQL URL is a config change rather than a code change.
- Does laravel-graphiql work with Lighthouse?
- Yes. laravel-graphiql is designed to sit in front of a Lighthouse GraphQL endpoint, which is the typical setup in Laravel applications. It also works with any other GraphQL endpoint as long as you provide the correct URL and any required headers.
- How do I protect the GraphiQL route with middleware or disable it in production?
- The package lets you attach middleware to its route, so you can require authentication or restrict access to non-public environments. Many teams simply disable or gate the route in production, because GraphiQL exposes schema introspection and ad-hoc query execution, which is an information-disclosure and query-abuse risk if left open. Treat enabling it in production as an explicit configuration decision.
- Which Laravel and PHP versions does laravel-graphiql support?
- laravel-graphiql v4.1.0 adds Laravel 13 support, and the package tracks Laravel's annual major release cadence, so each new Laravel major should be treated as a planned review checkpoint. The exact PHP floor and Laravel version range live in the package's composer.json, so run composer why-not mll-lab/laravel-graphiql in your application to confirm your pinned versions are compatible before merging.
- Does laravel-graphiql require npm or a frontend build step?
- No. laravel-graphiql ships a prebuilt GraphiQL page, so you install it with Composer and visit the route; there is no npm install or asset compilation step. Depending on the version, the GraphiQL JavaScript and CSS are either bundled with the package or loaded from a CDN, so check the release you install and adjust your CSP if assets come from a third-party origin.
- Can I use laravel-graphiql with an external or non-Lighthouse GraphQL API?
- Yes. The package only needs a URL, so it works with any GraphQL endpoint your Laravel app exposes, including a hand-rolled controller, a Lighthouse-backed schema, or a separate gateway. Point the configured endpoint at the API and add any required authentication headers through the config.
- How do I customize the GraphiQL UI, views, or add authentication headers?
- Publish the package config and views with vendor:publish, then edit the endpoint, route, and middleware options in config/graphiql.php. If your GraphQL endpoint requires authentication, configure the headers GraphiQL should send. If you need UI changes, override the published Blade view.
- How do I upgrade laravel-graphiql, and is it actively maintained?
- Update with composer update mll-lab/laravel-graphiql and smoke-test the GraphiQL route; v4.1.0 is an additive release with no removals or deprecations, so teams on v4.0.x should expect a no-op upgrade. If you are coming from an earlier major, diff the published config for renamed keys, re-publish, and verify the route and view namespace. The package is maintained by a small team with a narrow scope, so pin the version and plan a review each time you move to a new Laravel major.
Weaver
How can I help you explore Laravel packages today?