PHPackages rebing/graphql-laravel - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. rebing/graphql-laravel ActiveLibrary[Framework](/categories/framework) rebing/graphql-laravel ====================== Laravel wrapper for PHP GraphQL 10.0.0(2w ago)2.2k7.7M↓37%270[1 PRs](https://github.com/rebing/graphql-laravel/pulls)20MITPHPPHP ^8.2CI passing Since Mar 27Pushed 3d ago35 watchersCompare [ Source](https://github.com/rebing/graphql-laravel)[ Packagist](https://packagist.org/packages/rebing/graphql-laravel)[ GitHub Sponsors](https://github.com/mfn)[ RSS](/packages/rebing-graphql-laravel/feed)WikiDiscussions master Synced 3d ago READMEChangelog (10)Dependencies (45)Versions (147)Used By (20) Laravel GraphQL =============== [](#laravel-graphql) [![Latest Stable Version](https://camo.githubusercontent.com/0169144623818e8a58d199cb3d5b0d246ecccced18155c534b0b38643e5041aa/68747470733a2f2f706f7365722e707567782e6f72672f726562696e672f6772617068716c2d6c61726176656c2f762f737461626c65)](https://packagist.org/packages/rebing/graphql-laravel)[![License](https://camo.githubusercontent.com/d87eb1a0fa4a1b11555d255a6e9d341f20de6983e951730f3246a61d8f93abbc/68747470733a2f2f706f7365722e707567782e6f72672f726562696e672f6772617068716c2d6c61726176656c2f6c6963656e7365)](https://packagist.org/packages/rebing/graphql-laravel)[![Tests](https://github.com/rebing/graphql-laravel/workflows/Tests/badge.svg)](https://github.com/rebing/graphql-laravel/actions?query=workflow%3ATests)[![codecov](https://camo.githubusercontent.com/712d015db42bcf239810d027050ab1dfdde87f73fc4e3854af7a1189b982d84c/68747470733a2f2f636f6465636f762e696f2f67682f726562696e672f6772617068716c2d6c61726176656c2f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/rebing/graphql-laravel)[![Downloads](https://camo.githubusercontent.com/481ca82845ae04e240fb18d3537f223eb2a08d82557781799e4217b78db3c358/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f726562696e672f6772617068716c2d6c61726176656c2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/rebing/graphql-laravel)[![Get on Slack](https://camo.githubusercontent.com/15aa806a5685b67b0cf43579dc41f6aca3a52b9ecab9a7db4c3711ed74c77629/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d6f72616e67652e737667)](https://rebing-graphql.slack.com/join/shared_invite/enQtNTE5NjQzNDI5MzQ4LTdhNjk0ZGY1N2U1YjE4MGVlYmM2YTc2YjQ0MmIwODY5MWMwZWIwYmY1MWY4NTZjY2Q5MzdmM2Q3NTEyNDYzZjc#/shared-invite/email) This package provides a code-first integration of GraphQL for Laravel. It is based on the [PHP port of GraphQL reference implementation](https://github.com/webonyx/graphql-php). You define your schema entirely in PHP classes (types, queries, mutations) rather than in `.graphql` schema files. You can find more information about GraphQL in the [Introduction to GraphQL](https://graphql.org/learn/) or you can read the [GraphQL specifications](https://spec.graphql.org/). - Allows creating **queries** and **mutations** as request endpoints - Supports multiple schemas - per schema queries/mutations/types - per schema HTTP middlewares - per schema GraphQL execution middlewares - Custom GraphQL **resolver middleware** can be defined for each query/mutation - Two [data loading](#data-loading) strategies for avoiding n+1 queries: - **[Dataloaders](#dataloaders)** -- uses webonyx/graphql-php's built-in deferred resolution to batch field loads from any data source - **[SelectFields](https://github.com/rebing/graphql-laravel-select-fields)** (optional separate package) -- analyzes the GraphQL query to generate optimized Eloquent `select()` and eager-loaded `with()` calls - Queries return **types**, which can have custom **[privacy](#privacy)** settings > **Note:** GraphQL **subscriptions** are not supported by this package. If you need real-time push functionality, consider a dedicated solution like [Lighthouse](https://lighthouse-php.com/) (which has subscription support) or implement subscriptions separately via Laravel broadcasting / WebSockets. Table of Contents ----------------- [](#table-of-contents) - [Requirements](#requirements) - [Installation](#installation) - [Quick Start](#quick-start) - [1. Create a Type](#1-create-a-type) - [2. Create a Query](#2-create-a-query) - [3. Register in config](#3-register-in-config) - [4. Test it](#4-test-it) - [What's next?](#whats-next) - [Concepts](#concepts) - [A word on declaring a field `nonNull`](#a-word-on-declaring-a-field-nonnull) - [Data loading](#data-loading) - [Dataloaders (deferred resolution)](#dataloaders-deferred-resolution) - [Choosing an approach](#choosing-an-approach) - [Middleware Overview](#middleware-overview) - [HTTP middleware](#http-middleware) - [GraphQL execution middleware](#graphql-execution-middleware) - [GraphQL resolver middleware](#graphql-resolver-middleware) - [Schemas](#schemas) - [Route attributes](#route-attributes) - [Schema classes](#schema-classes) - [Creating a query](#creating-a-query) - [Creating a mutation](#creating-a-mutation) - [File uploads](#file-uploads) - [Vue.js example](#vuejs-example) - [Vanilla JavaScript](#vanilla-javascript) - [Validation](#validation) - [Example defining rules in each argument](#example-defining-rules-in-each-argument) - [Example using the `rules()` method](#example-using-the-rules-method) - [Example using Laravel's validator directly](#example-using-laravels-validator-directly) - [Handling validation errors](#handling-validation-errors) - [Customizing error messages](#customizing-error-messages) - [Customizing attributes](#customizing-attributes) - [Cross-field validation rules in nested input types](#cross-field-validation-rules-in-nested-input-types) - [Misc notes](#misc-notes) - [Resolve method](#resolve-method) - [Resolver middleware](#resolver-middleware) - [Defining middleware](#defining-middleware) - [Registering middleware](#registering-middleware) - [Terminable middleware](#terminable-middleware) - [Authorization](#authorization) - [Privacy](#privacy) - [Query variables](#query-variables) - [Custom field](#custom-field) - [Even better reusable fields](#even-better-reusable-fields) - [Dataloaders](#dataloaders) - [Creating a loader](#creating-a-loader) - [Using a loader in a type](#using-a-loader-in-a-type) - [Using a DataLoader library](#using-a-dataloader-library) - [Eager loading relationships](#eager-loading-relationships) - [Type relationship query](#type-relationship-query) - [Pagination](#pagination) - [Batching](#batching) - [Scalar types](#scalar-types) - [Enums](#enums) - [Unions](#unions) - [Interfaces](#interfaces) - [Supporting custom queries on interface relations](#supporting-custom-queries-on-interface-relations) - [Sharing interface fields](#sharing-interface-fields) - [Input Object](#input-object) - [OneOf Input Objects](#oneof-input-objects) - [Creating a OneOf Input Type](#creating-a-oneof-input-type) - [Using OneOf Input Types](#using-oneof-input-types) - [Generating OneOf Input Types](#generating-oneof-input-types) - [Type modifiers](#type-modifiers) - [Field and input alias](#field-and-input-alias) - [JSON columns](#json-columns) - [Field deprecation](#field-deprecation) - [Default field resolver](#default-field-resolver) - [Macros](#macros) - [Automatic Persisted Queries support](#automatic-persisted-queries-support) - [Notes](#notes) - [Client example](#client-example) - [Tracing / Observability](#tracing--observability) - [Enabling OpenTelemetry](#enabling-opentelemetry) - [Per-field resolver tracing](#per-field-resolver-tracing) - [Custom tracing drivers](#custom-tracing-drivers) - [Per-schema tracing](#per-schema-tracing) - [Security](#security) - [Introspection](#introspection) - [Query depth limiting](#query-depth-limiting) - [Query complexity analysis](#query-complexity-analysis) - [Batching limits](#batching-limits) - [GET requests and read-only enforcement](#get-requests-and-read-only-enforcement) - [Recommended production configuration](#recommended-production-configuration) - [Error handling](#error-handling) - [Built-in error types](#built-in-error-types) - [Error response format](#error-response-format) - [Error reporting](#error-reporting) - [Customizing error formatting](#customizing-error-formatting) - [Misc features](#misc-features) - [Detecting unused variables](#detecting-unused-variables) - [Configuration options](#configuration-options) - [Performance considerations](#performance-considerations) - [Wrap Types](#wrap-types) - [Using wrap types with SelectFields](#using-wrap-types-with-selectfields) - [Known limitations](#known-limitations) - [SelectFields related](#selectfields-related) - [GraphQL testing clients](#graphql-testing-clients) - [Testing](#testing) - [Querying an endpoint](#querying-an-endpoint) - [Using query variables](#using-query-variables) - [Testing mutations](#testing-mutations) - [Testing a non-default schema](#testing-a-non-default-schema) - [Asserting errors](#asserting-errors) - [Upgrading](#upgrading) Requirements ------------ [](#requirements) DependencyVersionPHP^8.2Laravel12.x - 13.xwebonyx/graphql-php^15.22.1Optional dependencies: PackagePurpose`open-telemetry/api` ^1.0Required for the [OpenTelemetry tracing driver](#tracing--observability)`mll-lab/laravel-graphiql`Interactive in-browser [GraphiQL](https://github.com/mll-lab/laravel-graphiql) IDEInstallation ------------ [](#installation) Require the package via Composer: ``` composer require rebing/graphql-laravel ``` Publish the configuration file via Laravel artisan: ``` php artisan vendor:publish --provider="Rebing\GraphQL\GraphQLServiceProvider" ``` Review the configuration file: ``` config/graphql.php ``` Quick Start ----------- [](#quick-start) Get a working GraphQL endpoint in under 5 minutes -- no database required. ### 1. Create a Type [](#1-create-a-type) Use the artisan generator to scaffold a type: ``` php artisan make:graphql:type BookType ``` Edit the generated `app/GraphQL/Types/BookType.php`: ``` declare(strict_types = 1); namespace App\GraphQL\Types; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Type as GraphQLType; class BookType extends GraphQLType { protected $attributes = [ 'name' => 'Book', 'description' => 'A book', ]; public function fields(): array { return [ 'id' => [ 'type' => Type::nonNull(Type::int()), 'description' => 'The id of the book', ], 'title' => [ 'type' => Type::nonNull(Type::string()), 'description' => 'The title of the book', ], 'author' => [ 'type' => Type::string(), 'description' => 'The name of the author', ], ]; } } ``` ### 2. Create a Query [](#2-create-a-query) ``` php artisan make:graphql:query BooksQuery ``` Edit `app/GraphQL/Queries/BooksQuery.php`: ``` declare(strict_types = 1); namespace App\GraphQL\Queries; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Facades\GraphQL; use Rebing\GraphQL\Support\Query; class BooksQuery extends Query { protected $attributes = [ 'name' => 'books', ]; public function type(): Type { return Type::nonNull(Type::listOf(Type::nonNull(GraphQL::type('Book')))); } public function args(): array { return [ 'title' => [ 'type' => Type::string(), 'description' => 'Filter by title', ], ]; } public function resolve($root, array $args): array { $books = [ ['id' => 1, 'title' => 'The Great Gatsby', 'author' => 'F. Scott Fitzgerald'], ['id' => 2, 'title' => '1984', 'author' => 'George Orwell'], ['id' => 3, 'title' => 'To Kill a Mockingbird', 'author' => 'Harper Lee'], ]; if (isset($args['title'])) { return array_values(array_filter($books, fn ($book) => str_contains($book['title'], $args['title']))); } return $books; } } ``` ### 3. Register in config [](#3-register-in-config) Add the type and query to the `default` schema in `config/graphql.php`: ``` 'schemas' => [ 'default' => [ 'query' => [ App\GraphQL\Queries\BooksQuery::class, ], 'mutation' => [], 'types' => [ App\GraphQL\Types\BookType::class, ], ], ], ``` ### 4. Test it [](#4-test-it) Start the dev server and send a query: ``` php artisan serve ``` ``` curl -X POST -H "Content-Type: application/json" \ -d '{"query": "{ books { id title author } }"}' \ http://localhost:8000/graphql ``` Expected response: ``` { "data": { "books": [ {"id": 1, "title": "The Great Gatsby", "author": "F. Scott Fitzgerald"}, {"id": 2, "title": "1984", "author": "George Orwell"}, {"id": 3, "title": "To Kill a Mockingbird", "author": "Harper Lee"} ] } } ``` Try filtering with an argument: ``` curl -X POST -H "Content-Type: application/json" \ -d '{"query": "{ books(title: \"1984\") { id title } }"}' \ http://localhost:8000/graphql ``` > **Tip:** For an interactive experience, install [GraphiQL](https://github.com/mll-lab/laravel-graphiql)(`composer require mll-lab/laravel-graphiql --dev`) and visit `/graphiql` in your browser. > **Note:** Introspection is disabled by default. To enable it during development (required for GraphiQL and IDE tooling), set `GRAPHQL_DISABLE_INTROSPECTION=false`in your `.env` file. ### What's next? [](#whats-next) You now have a working GraphQL API. From here you can: - **Optimize data loading** -- see [Dataloaders](#dataloaders) for the recommended way to avoid n+1 queries with any data source - **Use Eloquent models** -- see [Creating a query](#creating-a-query) for a full example with database-backed types; for Eloquent-specific column optimization see the optional [`rebing/graphql-laravel-select-fields`](https://github.com/rebing/graphql-laravel-select-fields) package - **Add mutations** -- see [Creating a mutation](#creating-a-mutation) to modify data - **Add validation** -- see [Validation](#validation) for built-in Laravel validation rules on arguments - **Add authorization** -- see [Authorization](#authorization) for per-operation access control - **Explore all generators** -- run `php artisan list make:graphql` to see all 12 available scaffolding commands Concepts -------- [](#concepts) Before diving head first into code, it's good to familiarize yourself with the concepts surrounding GraphQL. If you've already experience with GraphQL, feel free to skip this part. - "schema" A GraphQL schema defines all the queries, mutations and types associated with it. - "queries" and "mutations" The "methods" you call in your GraphQL request (think about your REST endpoint) - "types" Besides the primitive scalars like int and string, custom "shapes" can be defined and returned via custom types. They can map to your database models or basically any data you want to return. - "resolver" Any time data is returned, it is "resolved". Usually in query/mutations this specifies the primary way to retrieve your data. A common strategy is [dataloaders](#dataloaders) (deferred batching). See [Data loading](#data-loading) for more details. Typically, all queries/mutations/types are defined using the `$attributes`property and the `args()` / `fields()` methods as well as the `resolve()` method. args/fields again return a configuration array for each field they supported. Those fields usually support these shapes - the "key" is the name of the field - `type` (required): a GraphQL specifier for the type supported here Optional keys are: - `description`: made available when introspecting the GraphQL schema - `resolve`: override the default field resolver - `deprecationReason`: document why something is deprecated ### A word on declaring a field `nonNull` [](#a-word-on-declaring-a-field-nonnull) It's quite common, and actually good practice, to see the gracious use of `Type::nonNull()` on any kind of input and/or output fields. **The more specific the intent of your type system, the better for the consumer.** Some examples - if you require a certain field for a query/mutation argument, declare it non null - if you know that your (e.g. model) field can never return null (e.g. users ID, email, etc.), declare it no null - if you return a list of something, like e.g. tags, which is a) always an array (even empty) and b) shall not contain `null` values, declare the type like this: `Type::nonNull(Type::listOf(Type::nonNull(Type::string())))` There exists a lot of tooling in the GraphQL ecosystem, which benefits the more specific your type system is. Data loading ------------ [](#data-loading) The act of loading/retrieving your data is called "resolving" in GraphQL. GraphQL itself does **not** define the "how" and leaves it up to the implementor. You can use any kind of data source you like (Eloquent, static data, ElasticSearch results, caching, etc.) in your resolvers, but you need to be mindful of the execution model to avoid repetitive fetches. This library supports two strategies for optimized data loading. Dataloaders are the recommended starting point -- they work with any data source and follow the standard GraphQL community pattern for n+1 prevention. The optional [`rebing/graphql-laravel-select-fields`](https://github.com/rebing/graphql-laravel-select-fields)package is available as an Eloquent-specific alternative that offers column-level precision. ### Dataloaders (deferred resolution) [](#dataloaders-deferred-resolution) Dataloaders take advantage of the "deferred" execution model built into [webonyx/graphql-php](https://webonyx.github.io/graphql-php/data-fetching/#solving-n1-problem). Instead of analyzing the query upfront, each field resolver collects the keys it needs and defers the actual fetch. Once all non-deferred fields are resolved, the deferred callbacks fire, batching all collected keys into a single query. This is the recommended approach for most applications -- it works with **any data source** (Eloquent, APIs, caches, etc.) and does not require any special type configuration. See [Dataloaders](#dataloaders) for usage and examples. ### SelectFields (Eloquent eager loading) [](#selectfields-eloquent-eager-loading) > **Note:** SelectFields has been extracted to a separate optional package: [`rebing/graphql-laravel-select-fields`](https://github.com/rebing/graphql-laravel-select-fields). Install it via `composer require rebing/graphql-laravel-select-fields` to use the `SelectFields` class and its field configuration keys (`selectable`, `is_relation`, `always`, `query`). See the package's README for full documentation. ### Choosing an approach [](#choosing-an-approach) SelectFieldsDataloaders**Data source**Eloquent onlyAny (Eloquent, APIs, caches, etc.)**N+1 strategy**Upfront eager loading via query AST analysisDeferred batching at resolve time**Column precision**Selects only requested columnsTypically all columns (customizable per loader)**Setup**`composer require rebing/graphql-laravel-select-fields`Create a loader class, register in the container**Best for**Eloquent-heavy apps needing column-level optimizationMost applications; especially mixed data sources and cross-resolver batchingThe two approaches are independent and can coexist in the same application -- use `SelectFields` for some resolvers and dataloaders for others. Middleware Overview ------------------- [](#middleware-overview) The following middleware concepts are supported: - HTTP middleware (i.e. from Laravel) - GraphQL execution middleware - GraphQL resolver middleware Briefly said, a middleware *usually* is a class: - with a `handle` method - receiving a fixed set of parameters plus a callable for the next middleware - is responsible for calling the "next" middleware Usually a middleware does just that but may decide to not do that and just return - has the freedom to mutate the parameters passed on ### HTTP middleware [](#http-middleware) Any [Laravel compatible HTTP middleware](https://laravel.com/docs/middleware)can be provided on a global level for all GraphQL endpoints via the config `graphql.route.middleware` or on a per-schema basis via `graphql.schemas..middleware`. The per-schema middleware overrides the global one. ### GraphQL execution middleware [](#graphql-execution-middleware) The processing of a GraphQL request, henceforth called "execution", flows through a set of middlewares. They can be set on global level via `graphql.execution_middleware` or per-schema via `graphql.schemas..execution_middleware`. By default, the recommended set of middlewares is provided on the global level. Note: the execution of the GraphQL request *itself* is also implemented via a middleware, which is usually expected to be called last (and does not call further middlewares). In case you're interested in the details, please see `\Rebing\GraphQL\GraphQL::appendGraphqlExecutionMiddleware` ### GraphQL resolver middleware [](#graphql-resolver-middleware) After the HTTP middleware and the execution middleware is applied, the "resolver middleware" is executed for the query/mutation being targeted **before** the actual `resolve()` method is called. See [Resolver middleware](#resolver-middleware) for more details. Schemas ------- [](#schemas) Schemas are required for defining GraphQL endpoints. You can define multiple schemas and assign different **HTTP middleware** and **execution middleware** to them, in addition to the global middleware. For example: ``` 'default_schema' => 'default', 'schemas' => [ 'default' => [ 'query' => [ ExampleQuery::class, ], 'mutation' => [ ExampleMutation::class, ], 'types' => [ ], ], 'user' => [ 'query' => [ App\GraphQL\Queries\ProfileQuery::class ], 'mutation' => [ ], 'types' => [ ], 'middleware' => ['auth:api'], // Which HTTP methods to support; must be given in UPPERCASE! // Default is POST only; enable GET explicitly if needed 'method' => ['GET', 'POST'], 'execution_middleware' => [ \Rebing\GraphQL\Support\ExecutionMiddleware\UnusedVariablesMiddleware::class, ], // Route attributes applied to the generated HTTP route for this schema // Example: expose this schema on a dedicated subdomain 'route_attributes' => [ 'domain' => 'api.example.com', ], // Per-schema route group attributes. The `guard` entry is consumed by // the built-in `AddAuthUserContextValueMiddleware` to populate the // GraphQL context value (`$ctx`) from the named guard. Defaults to // the application's default guard when unset. 'group_attributes' => [ 'guard' => 'api', ], // Override the default controller for this schema. // Supports string ('Class@method') and array ([Class::class, 'method']) formats. // The controller method receives the same parameters as GraphQLController@query. // 'controller' => App\Http\Controllers\MyGraphQLController::class . '@query', ], ], ``` Together with the configuration, in a way the schema defines also the route by which it is accessible. Per the default configuration of `prefix = graphql`, the *default* schema is accessible via `/graphql`. ### Route attributes [](#route-attributes) You can customize the HTTP route generated for a specific schema using the `route_attributes` key. This is useful for setting parameters supported by Laravel routes, e.g. a custom `domain`. The attributes are merged into the route's action array, so standard Laravel route attributes like `domain`, `prefix`, `as` (route name), and `where` (parameter constraints) are all supported. ``` 'schemas' => [ 'with_custom_domain' => [ 'query' => [ App\GraphQL\Queries\UsersQuery::class, ], 'middleware' => ['auth:api'], 'route_attributes' => [ 'domain' => 'api.example.com', ], ], ] ``` ### Schema classes [](#schema-classes) You may alternatively define the configuration of a schema in a class that implements `ConfigConvertible`. In your config, you can reference the name of the class, rather than an array. ``` 'schemas' => [ 'default' => DefaultSchema::class ] ``` ``` declare(strict_types = 1); namespace App\GraphQL\Schemas; use Rebing\GraphQL\Support\Contracts\ConfigConvertible; class DefaultSchema implements ConfigConvertible { public function toConfig(): array { return [ 'query' => [ ExampleQuery::class, ], 'mutation' => [ ExampleMutation::class, ], 'types' => [ ], ]; } } ``` You can use the `php artisan make:graphql:schemaConfig` command to create a new schema configuration class automatically. Creating a query ---------------- [](#creating-a-query) First you usually create a type you want to return from the query. The Eloquent `'model'` is only required if specifying relations. > **Note:** If you use the [`rebing/graphql-laravel-select-fields`](https://github.com/rebing/graphql-laravel-select-fields)package, you can set `'selectable' => false` on computed/virtual fields that don't correspond to a database column (e.g. accessors, custom resolvers). ``` declare(strict_types = 1); namespace App\GraphQL\Types; use App\Models\User; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Facades\GraphQL; use Rebing\GraphQL\Support\Type as GraphQLType; class UserType extends GraphQLType { protected $attributes = [ 'name' => 'User', 'description' => 'A user', // Note: only necessary if you use the SelectFields package 'model' => User::class, ]; public function fields(): array { return [ 'id' => [ 'type' => Type::nonNull(Type::string()), 'description' => 'The id of the user', // Use 'alias', if the database column is different from the type name. // This is supported for discrete values as well as relations. // - you can also use `DB::raw()` to solve more complex issues // - or a callback returning the value (string or `DB::raw()` result) 'alias' => 'user_id', ], 'email' => [ 'type' => Type::string(), 'description' => 'The email of user', 'resolve' => function($root, array $args) { // If you want to resolve the field yourself, // it can be done here return strtolower($root->email); } ], // Uses the 'getIsMeAttribute' function on our custom User model 'isMe' => [ 'type' => Type::boolean(), 'description' => 'True, if the queried user is the current user', 'selectable' => false, // Does not try to query this from the database ], // Reference another registered GraphQL type for relations 'profile' => [ 'type' => GraphQL::type('UserProfile'), 'description' => 'The user profile', ], ]; } // You can also resolve a field by declaring a method in the class // with the following format resolve[FIELD_NAME]Field() protected function resolveEmailField($root, array $args) { return strtolower($root->email); } } ``` The best practice is to start with your schema in `config/graphql.php` and add types directly to your schema (e.g. `default`): ``` 'schemas' => [ 'default' => [ // ... 'types' => [ App\GraphQL\Types\UserType::class, ], ``` Alternatively you can: - add the type on the "global" level, e.g. directly in the root config: ``` 'types' => [ App\GraphQL\Types\UserType::class, ], ``` Adding them on the global level allows to share them between different schemas but be aware this might make it harder to understand which types/fields are used where. - or add the type with the `GraphQL` Facade, in a service provider for example. ``` GraphQL::addType(\App\GraphQL\Types\UserType::class); ``` - or register multiple types at once with `addTypes`: ``` GraphQL::addTypes([ \App\GraphQL\Types\UserType::class, 'CustomName' => \App\GraphQL\Types\PostType::class, ]); ``` Both indexed entries (class name auto-resolved) and associative entries (explicit name => class) are supported. Then you need to define a query that returns this type (or a list). You can also specify arguments that you can use in the resolve method. ``` declare(strict_types = 1); namespace App\GraphQL\Queries; use Closure; use App\Models\User; use Rebing\GraphQL\Support\Facades\GraphQL; use GraphQL\Type\Definition\ResolveInfo; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Query; class UsersQuery extends Query { protected $attributes = [ 'name' => 'users', ]; public function type(): Type { return Type::nonNull(Type::listOf(Type::nonNull(GraphQL::type('User')))); } public function args(): array { return [ 'id' => [ 'type' => Type::string(), ], 'email' => [ 'type' => Type::string(), ] ]; } public function resolve($root, array $args, $context, ResolveInfo $resolveInfo) { if (isset($args['id'])) { return User::where('id' , $args['id'])->get(); } if (isset($args['email'])) { return User::where('email', $args['email'])->get(); } return User::all(); } } ``` Add the query to the `config/graphql.php` configuration file ``` 'schemas' => [ 'default' => [ 'query' => [ App\GraphQL\Queries\UsersQuery::class ], // ... ] ] ``` #### Fetching a single record [](#fetching-a-single-record) ``` declare(strict_types = 1); namespace App\GraphQL\Queries; use App\Models\User; use GraphQL\Type\Definition\ResolveInfo; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Facades\GraphQL; use Rebing\GraphQL\Support\Query; class UserQuery extends Query { protected $attributes = [ 'name' => 'user', ]; public function type(): Type { return Type::nonNull(GraphQL::type('User')); } public function args(): array { return [ 'id' => [ 'type' => Type::nonNull(Type::int()), ], ]; } public function resolve($root, array $args, $context, ResolveInfo $resolveInfo) { return User::findOrFail($args['id']); } } ``` And that's it. You should be able to query GraphQL with a POST request to the url `/graphql` (or anything you choose in your config). Try a POST request with the following `query` input > **Note:** The `resolve()` method supports dependency injection for parameters beyond the first three (`$root`, `$args`, `$context`). You can typehint `ResolveInfo $info` to receive the GraphQL resolve info. Any other class typehint will be resolved from Laravel's service container. External packages can register custom parameter injectors via `Field::registerParameterInjector()`. See [Resolve method](#resolve-method) for full details. ``` query FetchUsers { users { id email } } ``` For example, using `curl`: ``` curl -X POST -H "Content-Type: application/json" \ -d '{"query": "query FetchUsers { users { id email } }"}' \ http://localhost:8000/graphql ``` Creating a mutation ------------------- [](#creating-a-mutation) A mutation is like any other query. It accepts arguments and returns an object of a certain type. Mutations are meant to be used for operations **modifying** (mutating) the state on the server (which queries are not supposed to perform). This is conventional abstraction, technically you can do anything you want in a query resolve, including mutating state. For example, a mutation to update the password of a user. First you need to define the Mutation: ``` declare(strict_types = 1); namespace App\GraphQL\Mutations; use Closure; use App\Models\User; use Illuminate\Support\Facades\Hash; use Rebing\GraphQL\Support\Facades\GraphQL; use GraphQL\Type\Definition\Type; use GraphQL\Type\Definition\ResolveInfo; use Rebing\GraphQL\Support\Mutation; class UpdateUserPasswordMutation extends Mutation { protected $attributes = [ 'name' => 'updateUserPassword' ]; public function type(): Type { return Type::nonNull(GraphQL::type('User')); } public function args(): array { return [ 'id' => [ 'type' => Type::nonNull(Type::string()), ], 'password' => [ 'type' => Type::nonNull(Type::string()), ] ]; } public function resolve($root, array $args, $context, ResolveInfo $resolveInfo) { $user = User::find($args['id']); if(!$user) { return null; } $user->password = Hash::make($args['password']); $user->save(); return $user; } } ``` As you can see in the `resolve()` method, you use the arguments to update your model and return it. You should then add the mutation to the `config/graphql.php` configuration file: ``` 'schemas' => [ 'default' => [ 'mutation' => [ App\GraphQL\Mutations\UpdateUserPasswordMutation::class, ], // ... ] ] ``` You can then use the following query on your endpoint to do the mutation: ``` mutation users { updateUserPassword(id: "1", password: "newpassword") { id email } } ``` For example, using `curl`: ``` curl -X POST -H "Content-Type: application/json" \ -d '{"query": "mutation users { updateUserPassword(id: \"1\", password: \"newpassword\") { id email } }"}' \ http://localhost:8000/graphql ``` #### Mutation with inline validation rules [](#mutation-with-inline-validation-rules) You can attach Laravel validation rules directly to each argument via the `'rules'` key. This is often simpler than overriding the `rules()` method for straightforward validations: ``` declare(strict_types = 1); namespace App\GraphQL\Mutations; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Facades\GraphQL; use Rebing\GraphQL\Support\Mutation; class LoginMutation extends Mutation { protected $attributes = [ 'name' => 'login', 'description' => 'Log in by email and password', ]; public function type(): Type { return GraphQL::type('User'); } public function args(): array { return [ 'email' => [ 'type' => Type::nonNull(Type::string()), 'rules' => ['required', 'email'], ], 'password' => [ 'type' => Type::nonNull(Type::string()), 'rules' => ['required', 'string', 'min:8'], ], 'remember_me' => [ 'type' => Type::boolean(), 'rules' => ['boolean'], ], ]; } public function resolve($root, array $args) { // Authenticate and return the user... } } ``` See [Validation](#validation) for more advanced rule definitions including the `rules()` method, callable rules, and nested input type rules. ### File uploads [](#file-uploads) This library uses which is compliant with the spec at . You have to add the `\Rebing\GraphQL\Support\UploadType` first to your `config/graphql` schema types definition (either global or in your schema): ``` 'types' => [ \Rebing\GraphQL\Support\UploadType::class, ], ``` It is important that you send the request as `multipart/form-data`: > **WARNING:** when you are uploading files, Laravel will use FormRequest - it means that middlewares which are changing request, will not have any effect. ``` declare(strict_types = 1); namespace App\GraphQL\Mutations; use Closure; use GraphQL\Type\Definition\ResolveInfo; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Facades\GraphQL; use Rebing\GraphQL\Support\Mutation; class UserProfilePhotoMutation extends Mutation { protected $attributes = [ 'name' => 'userProfilePhoto', ]; public function type(): Type { return GraphQL::type('User'); } public function args(): array { return [ 'profilePicture' => [ 'type' => GraphQL::type('Upload'), 'rules' => ['required', 'image', 'max:1500'], ], ]; } public function resolve($root, array $args, $context, ResolveInfo $resolveInfo) { $file = $args['profilePicture']; // Do something with file here... } } ``` Note: You can test your file upload implementation using [Altair](https://altairgraphql.dev/) as explained [here](https://altairgraphql.dev/docs/features/file-upload). #### Vue.js example [](#vuejs-example) ``` Upload import { ref } from 'vue'; const file = ref(null); const fileInput = ref(null); function handleFileChange() { file.value = fileInput.value.files[0]; } async function upload() { if (!file.value) return; const formData = new FormData(); formData.set('operations', JSON.stringify({ query: `mutation uploadSingleFile($file: Upload!) { upload_single_file(attachment: $file) }`, variables: { attachment: null }, })); formData.set('map', JSON.stringify({ '0': ['variables.attachment'] })); formData.append('0', file.value); const response = await fetch('/graphql', { method: 'POST', body: formData, }); const result = await response.json(); if (!result.errors) { file.value = null; } } ``` #### Vanilla JavaScript [](#vanilla-javascript) ``` ``` ``` const fileInput = document.getElementById('fileUpload'); const file = fileInput.files[0]; const formData = new FormData(); formData.set('operations', JSON.stringify({ query: `mutation uploadSingleFile($file: Upload!) { upload_single_file(attachment: $file) }`, variables: { attachment: null }, })); formData.set('map', JSON.stringify({ '0': ['variables.attachment'] })); formData.append('0', file); const response = await fetch('/graphql', { method: 'POST', body: formData, }); const result = await response.json(); ``` Validation ---------- [](#validation) Laravel's validation is supported on queries, mutations, input types and field arguments. > **Note:** The support is "sugar on top" and is provided as a convenience. It may have limitations in certain cases, in which case regular Laravel validation can be used in your respective `resolve()` methods, just like in regular Laravel code. Adding validation rules is supported in the following ways: - the field configuration key `'rules'` is supported - in queries/mutations in fields declared in `function args()` - in input types in fields declared in `function fields()` - `'args'` declared for a field - Overriding `\Rebing\GraphQL\Support\Field::rules` on any query/mutation/input type - Or directly use Laravel's `Validator` in your `resolve()` method Using the configuration key `'rules'` is very convenient, as it is declared in the same location as the GraphQL type itself. However, you may hit certain restrictions with this approach (like multi-field validation using `*`), in which case you can override the `rules()` method. ### Example defining rules in each argument [](#example-defining-rules-in-each-argument) ``` class UpdateUserEmailMutation extends Mutation { //... public function args(): array { return [ 'id' => [ 'type' => Type::string(), 'rules' => ['required'] ], 'email' => [ 'type' => Type::string(), 'rules' => ['required', 'email'] ] ]; } //... } ``` ### Example using the `rules()` method [](#example-using-the-rules-method) ``` declare(strict_types = 1); namespace App\GraphQL\Mutations; use Closure; use App\Models\User; use Rebing\GraphQL\Support\Facades\GraphQL; use GraphQL\Type\Definition\ResolveInfo; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Mutation; class UpdateUserEmailMutation extends Mutation { protected $attributes = [ 'name' => 'updateUserEmail' ]; public function type(): Type { return GraphQL::type('User'); } public function args(): array { return [ 'id' => [ 'type' => Type::string(), ], 'email' => [ 'type' => Type::string(), ] ]; } protected function rules(array $args = []): array { return [ 'id' => ['required'], 'email' => ['required', 'email'], 'password' => $args['id'] !== 1337 ? ['required'] : [], ]; } public function resolve($root, array $args) { $user = User::find($args['id']); if (!$user) { return null; } $user->email = $args['email']; $user->save(); return $user; } } ``` ### Example using Laravel's validator directly [](#example-using-laravels-validator-directly) Calling `validate()` in the example below will throw Laravel's `ValidationException`which is handed by the default `error_formatter` by this library: ``` protected function resolve($root, array $args) { \Illuminate\Support\Facades\Validator::make($args, [ 'data.*.password' => 'string|nullable|same:data.*.password_confirmation', ])->validate(); } ``` The format of the `'rules'` configuration key, or the rules returned by the `rules()` method, follows the same convention that Laravel supports, e.g.: - `'rules' => 'required|string'` or - `'rules' => ['required', 'string']` or - `'rules' => function (…) { … }` etc. For the `args()` method or the `'args'` definition for a field, the field names are directly used for the validation. However, for input types, which can be nested and occur multiple times, the field names are mapped as e.g. `data.0.fieldname`. This is important to understand when returning rules from the `rules()` method. ### Handling validation errors [](#handling-validation-errors) Exceptions are used to communicate back in the GraphQL response that validation errors occurred. When using the built-in support, the exception `\Rebing\GraphQL\Error\ValidationError` is thrown. In your custom code or when directly using the Laravel `Validator`, Laravel's built-in `\Illuminate\Validation\ValidationException` is supported too. In both cases, the GraphQL response is transformed to the error format shown below. To support returning validation errors in a GraphQL error response, the `'extensions'` are used, as there's no proper equivalent. On the client side, you can check if `message` for a given error matches `'validation'`, you can expect the `extensions.validation` key which maps each field to their respective errors: ``` { "data": { "updateUserEmail": null }, "errors": [ { "message": "validation", "extensions": { "validation": { "email": [ "The email is invalid." ] } }, "locations": [ { "line": 1, "column": 20 } ] } ] } ``` You can customize the way this is handled by providing your own `error_formatter`in the configuration, replacing the default one from this library. ### Customizing error messages [](#customizing-error-messages) The validation errors returned can be customised by overriding the `validationErrorMessages` method. This method should return an array of custom validation messages in the same way documented by Laravel's validation. For example, to check an `email` argument doesn't conflict with any existing data, you could perform the following: > **Note:** the keys should be in `field_name`.`validator_type` format, so you can return specific errors per validation type. ``` public function validationErrorMessages(array $args = []): array { return [ 'name.required' => 'Please enter your full name', 'name.string' => 'Your name must be a valid string', 'email.required' => 'Please enter your email address', 'email.email' => 'Please enter a valid email address', 'email.exists' => 'Sorry, this email address is already in use', ]; } ``` ### Customizing attributes [](#customizing-attributes) The validation attributes can be customised by overriding the `validationAttributes` method. This method should return an array of custom attributes in the same way documented by Laravel's validation. ``` public function validationAttributes(array $args = []): array { return [ 'email' => 'email address', ]; } ``` ### Cross-field validation rules in nested input types [](#cross-field-validation-rules-in-nested-input-types) When using Laravel validation rules that reference sibling fields (like `prohibits`, `required_without`, `required_if`, etc.) within an InputType, the library automatically transforms those references into fully-qualified dot-notation paths that Laravel's Validator can resolve correctly. For example, given an InputType: ``` class RecipientInput extends InputType { protected $attributes = ['name' => 'RecipientInput']; public function fields(): array { return [ 'createParams' => [ 'type' => Type::string(), 'rules' => ['nullable', 'prohibits:mintParams'], ], 'mintParams' => [ 'type' => Type::string(), 'rules' => ['nullable', 'prohibits:createParams'], ], ]; } } ``` Used in a mutation as a list: ``` public function args(): array { return [ 'recipients' => [ 'type' => Type::nonNull(Type::listOf(Type::nonNull(GraphQL::type('RecipientInput')))), ], ]; } ``` The `prohibits:mintParams` rule on `recipients.0.createParams` is automatically transformed to `prohibits:recipients.0.mintParams` so that Laravel's Validator correctly resolves the sibling field reference. This applies to all dependent rules including `prohibits`, `required_with`, `required_with_all`, `required_without`, `required_without_all`, `present_with`, `present_with_all`, `missing_with`, `missing_with_all`, `exclude_with`, `exclude_without`, `same`, `different`, `required_if`, `required_unless`, `prohibited_if`, `prohibited_unless`, `exclude_if`, `exclude_unless`, `accepted_if`, `declined_if`, `present_if`, `present_unless`, `missing_if`, `missing_unless`, `required_if_accepted`, `required_if_declined`, `prohibited_if_accepted`, `prohibited_if_declined`, and comparison rules like `gt`, `gte`, `lt`, `lte`, `before`, `after`, `before_or_equal`, `after_or_equal`(when they reference a sibling field). For rules like `required_if` that take both a field reference and a value (e.g. `required_if:mode,advanced`), only the field reference parameter is transformed. See `RulesPrefixer` for the full list. **Disabling automatic prefixing:** If you need to opt out of this behavior for a specific query or mutation, override `processCollectedRules()`: ``` class MyMutation extends Mutation { protected function processCollectedRules(array $rules): array { return $rules; // disable automatic cross-field rule prefixing } } ``` ### Misc notes [](#misc-notes) Certain type declarations of GraphQL may cancel our or render certain validations unnecessary. A good example is using `Type::nonNull()` to ultimately declare that an argument is required. In such a case a `'rules' => 'required'`configuration will likely never be triggered, because the GraphQL execution engine already prevents this field from being accepted in the first place. Or to be more clear: if a GraphQL type system violation occurs, then no Laravel validation will be even executed, as the code does not get so far. Resolve method -------------- [](#resolve-method) The resolve method is used in both queries and mutations, and it's here that responses are created. The first three parameters to the resolve method are hard-coded: 1. The `$root` object this resolve method belongs to (can be `null`) 2. The arguments passed as `array $args` (can be an empty array) 3. The query specific GraphQL context Can be customized by implementing a custom "execution middleware", see `\Rebing\GraphQL\Support\ExecutionMiddleware\AddAuthUserContextValueMiddleware`for an example. Arguments here after will be attempted to be injected, similar to how controller methods works in Laravel. You can typehint any class that you will need an instance of. There are two hardcoded classes which depend on the local data for the query: - `GraphQL\Type\Definition\ResolveInfo` has information useful for field resolution process. - Any class registered via `Field::registerParameterInjector()` (e.g. the `SelectFields` class from `rebing/graphql-laravel-select-fields`). Example: ``` declare(strict_types = 1); namespace App\GraphQL\Queries; use App\Models\User; use Rebing\GraphQL\Support\Facades\GraphQL; use GraphQL\Type\Definition\Type; use GraphQL\Type\Definition\ResolveInfo; use Rebing\GraphQL\Support\Query; use SomeClassNamespace\SomeClassThatDoLogging; class UsersQuery extends Query { protected $attributes = [ 'name' => 'users', ]; public function type(): Type { return Type::listOf(GraphQL::type('User')); } public function args(): array { return [ 'id' => [ 'type' => Type::string(), ] ]; } public function resolve($root, array $args, $context, ResolveInfo $info, SomeClassThatDoLogging $logging) { $logging->log('fetched user'); $users = User::all(); return $users->get(); } } ``` Resolver middleware ------------------- [](#resolver-middleware) These are **GraphQL specific resolver middlewares** and are only conceptually related to Laravel's "HTTP middleware". The main difference: - Laravel's HTTP middleware: - works on the schema / route level - is compatible with any regular Laravel HTTP middleware - is the same for all queries/mutations in a schema - Resolver middleware - Works similar in concept - But applies on the query/mutation level, i.e. can be different for every query/mutation - Is technically not compatible with HTTP middleware - Takes different arguments ### Defining middleware [](#defining-middleware) To create a new middleware, use the `make:graphql:middleware` Artisan command ``` php artisan make:graphql:middleware ResolvePage ``` This command will place a new ResolvePage class within your app/GraphQL/Middleware directory. In this middleware, we will set the Paginator current page to the argument we accept via our `PaginationType`: ``` declare(strict_types = 1); namespace App\GraphQL\Middleware; use Closure; use GraphQL\Type\Definition\ResolveInfo; use Illuminate\Pagination\Paginator; use Rebing\GraphQL\Support\Middleware; class ResolvePage extends Middleware { public function handle($root, array $args, $context, ResolveInfo $info, Closure $next) { Paginator::currentPageResolver(function () use ($args) { return $args['pagination']['page'] ?? 1; }); return $next($root, $args, $context, $info); } } ``` ### Registering middleware [](#registering-middleware) If you would like to assign middleware to specific queries/mutations, list the middleware class in the `$middleware` property of your query class. ``` declare(strict_types = 1); namespace App\GraphQL\Queries; use App\GraphQL\Middleware; use Rebing\GraphQL\Support\Query; class UsersQuery extends Query { protected $middleware = [ Middleware\Logstash::class, Middleware\ResolvePage::class, ]; } ``` If you want a middleware to run during every GraphQL query/mutation to your application, list the middleware class in the `$middleware` property of your base query class. ``` declare(strict_types = 1); namespace App\GraphQL\Queries; use App\GraphQL\Middleware; use Rebing\GraphQL\Support\Query as BaseQuery; abstract class Query extends BaseQuery { protected $middleware = [ Middleware\Logstash::class, Middleware\ResolvePage::class, ]; } ``` Alternatively, you can override `getMiddleware` to supply your own logic: ``` protected function getMiddleware(): array { return array_merge([...], $this->middleware); } ``` If you want to register middleware globally, use the `resolver_middleware_append` key in `config/graphql.php` (defaults to `null`, treated as an empty array): ``` return [ ... 'resolver_middleware_append' => [YourMiddleware::class], ]; ``` You can also use the `appendGlobalResolverMiddleware` method in any ServiceProvider: ``` ... public function boot() { ... GraphQL::appendGlobalResolverMiddleware(YourMiddleware::class); // Or with new instance GraphQL::appendGlobalResolverMiddleware(new YourMiddleware(...)); } ``` If your middleware needs to wrap **all** other resolver middleware (including per-field middleware), use `prependGlobalResolverMiddleware` instead: ``` GraphQL::prependGlobalResolverMiddleware(YourOutermostMiddleware::class); ``` The resulting pipeline order is: prepended global middleware, per-field middleware, appended global middleware. This is used internally by the tracing system but is available for any middleware that must run outermost. ### Terminable middleware [](#terminable-middleware) Sometimes a middleware may need to do some work after the response has been sent to the browser. If you define a terminate method on your middleware and your web server is using FastCGI, the terminate method will automatically be called after the response is sent to the browser: ``` declare(strict_types = 1); namespace App\GraphQL\Middleware; use Countable; use GraphQL\Language\Printer; use GraphQL\Type\Definition\ResolveInfo; use Illuminate\Contracts\Pagination\LengthAwarePaginator; use Illuminate\Pagination\AbstractPaginator; use Illuminate\Support\Arr; use Illuminate\Support\Facades\Config; use Illuminate\Support\Facades\Log; use Illuminate\Support\Facades\Route; use Rebing\GraphQL\Support\Middleware; class Logstash extends Middleware { public function terminate($field, array $args, $context, ResolveInfo $info, $result): void { Log::channel('logstash')->info('', ( collect([ 'query' => $info->fieldName, 'operation' => $info->operation->name->value ?? null, 'type' => $info->operation->operation, 'fields' => array_keys(Arr::dot($info->getFieldSelection($depth = PHP_INT_MAX))), 'schema' => Arr::first(Route::current()->parameters()) ?? Config::get('graphql.default_schema', 'default'), 'vars' => $this->formatVariableDefinitions($info->operation->variableDefinitions), ]) ->when($result instanceof Countable, function ($metadata) use ($result) { return $metadata->put('count', $result->count()); }) ->when($result instanceof AbstractPaginator, function ($metadata) use ($result) { return $metadata->put('per_page', $result->perPage()); }) ->when($result instanceof LengthAwarePaginator, function ($metadata) use ($result) { return $metadata->put('total', $result->total()); }) ->merge($this->formatArguments($args)) ->toArray() )); } private function formatArguments(array $args): array { return collect($args) ->mapWithKeys(function ($value, $key) { return ["\${$key}" => $value]; }) ->toArray(); } private function formatVariableDefinitions(?iterable $variableDefinitions = []): array { return collect($variableDefinitions) ->map(function ($def) { return Printer::doPrint($def); }) ->toArray(); } } ``` The terminate method receives both the resolver arguments and the query result. Once you have defined a terminable middleware, you should add it to the list of middleware in your queries and mutations. Authorization ------------- [](#authorization) For authorization similar to Laravel's Request (or middleware) functionality, we can override the `authorize()` function in a Query or Mutation. > **Important:** The `authorize()` method must return exactly `true` (strict comparison) for the request to proceed. Returning other truthy values (e.g. `1`, `"yes"`) will be treated as unauthorized. > **Note:** Authorization is checked **before** validation rules are evaluated. This prevents unauthenticated users from probing validation rules to discover API structure. An example of Laravel's `'auth'` middleware: ``` declare(strict_types = 1); namespace App\GraphQL\Queries; use Illuminate\Support\Facades\Auth; use GraphQL\Type\Definition\ResolveInfo; class UsersQuery extends Query { public function authorize($root, array $args, $ctx, ResolveInfo $resolveInfo = null): bool { // true, if logged in return ! Auth::guest(); } // ... } ``` Or we can make use of arguments passed via the GraphQL query: ``` declare(strict_types = 1); namespace App\GraphQL\Queries; use Illuminate\Support\Facades\Auth; use GraphQL\Type\Definition\ResolveInfo; class UsersQuery extends Query { public function authorize($root, array $args, $ctx, ResolveInfo $resolveInfo = null): bool { if (isset($args['id'])) { return Auth::id() == $args['id']; } return true; } // ... } ``` You can also provide a custom error message when the authorization fails (defaults to Unauthorized): ``` declare(strict_types = 1); namespace App\GraphQL\Queries; use Illuminate\Support\Facades\Auth; use GraphQL\Type\Definition\ResolveInfo; class UsersQuery extends Query { public function authorize($root, array $args, $ctx, ResolveInfo $resolveInfo = null): bool { if (isset($args['id'])) { return Auth::id() == $args['id']; } return true; } public function getAuthorizationMessage(): string { return 'You are not authorized to perform this action'; } // ... } ``` If you share the same authorization logic across multiple queries or mutations, extract it into a reusable trait: ``` declare(strict_types = 1); namespace App\GraphQL\Concerns; use Illuminate\Support\Facades\Auth; trait RequiresAuthentication { public function authorize($root, array $args, $ctx): bool { return !Auth::guest(); } } ``` Then use it on any query or mutation: ``` class UsersQuery extends Query { use \App\GraphQL\Concerns\RequiresAuthentication; // ... } ``` Privacy ------- [](#privacy) You can set custom privacy attributes for every Type's Field. If a field is not allowed, `null` will be returned. Privacy is enforced at the field resolver level, so it works universally - whether the type is a root query result or a nested sub-type. The privacy callback receives four arguments: the **root value** (`$root` - the parent object being resolved), the **field's own arguments** (`$args`), the **query context** (`$ctx`), and optionally the **ResolveInfo** (`$info`). **Using a closure:** ``` use Illuminate\Support\Facades\Auth; class UserType extends GraphQLType { // ... public function fields(): array { return [ 'id' => [ 'type' => Type::nonNull(Type::string()), 'description' => 'The id of the user', ], 'email' => [ 'type' => Type::string(), 'description' => 'The email of user', 'privacy' => function (mixed $root, array $args, $ctx): bool { // Only the authenticated user can see their own email. // $root is the User model being resolved. // $ctx is the query context value (see notes below). // By default, AddAuthUserContextValueMiddleware sets // $ctx to the authenticated user model directly. return $root->id === Auth::id(); }, ], ]; } // ... } ``` **Using a Privacy class:** You can also create a class that extends the abstract `Privacy` class: ``` use Illuminate\Support\Facades\Auth; use GraphQL\Type\Definition\ResolveInfo; use Rebing\GraphQL\Support\Privacy; class MePrivacy extends Privacy { public function validate(mixed $root, array $fieldArgs, mixed $queryContext = null, ?ResolveInfo $resolveInfo = null): bool { return $root->id === Auth::id(); } } ``` Then reference it by class name on the field: ``` use MePrivacy; class UserType extends GraphQLType { // ... public function fields(): array { return [ 'id' => [ 'type' => Type::nonNull(Type::string()), 'description' => 'The id of the user', ], 'email' => [ 'type' => Type::string(), 'description' => 'The email of user', 'privacy' => MePrivacy::class, ], ]; } // ... } ``` **Using field arguments in a privacy check:** If the field declares its own `args`, they are available in `$args`: ``` 'ssn' => [ 'type' => Type::string(), 'args' => [ 'reason' => [ 'type' => Type::nonNull(Type::string()), ], ], 'privacy' => function (mixed $root, array $args, $ctx): bool { // Only allow access when a valid reason is provided. return in_array($args['reason'] ?? '', ['legal', 'compliance']); }, ], ``` > **`$root` - the parent object.** This is the result of the parent field's resolver. For fields on a `UserType` resolved from a query returning Eloquent models, `$root` will be the `User` model instance. This allows per-row privacy decisions (e.g. only show a field if the current user "owns" the object). > **`$args` - field arguments, not query arguments.** The `$args` parameter contains the arguments declared on the field itself (via the `args` key). If the field declares no arguments, `$args` will be an empty array. These are *not* the root query/mutation arguments. > **`$ctx` - the query context value.** This is the context value passed to the GraphQL execution. By default, the built-in `AddAuthUserContextValueMiddleware` execution middleware sets this directly to the authenticated user model (i.e. `Auth::user()`), or `null` if no user is authenticated. The guard is resolved in this order: `graphql.schemas..group_attributes.guard` (per-schema), then the global `graphql.route.group_attributes.guard`, then the application's default guard. This keeps the GraphQL context consistent with the guard that authenticated the route — important in multi-guard apps where the default guard (typically `web`) and the schema's actual guard (e.g. `api`) differ. You can customize the context via your own execution middleware. > **Privacy vs Authorization.** `authorize()` on a Query or Mutation gates the *entire* operation - if it fails, the whole request is rejected with an error. `privacy` on a Type field gates *individual fields* and silently returns `null` when denied. Use `authorize()` for access control on operations and `privacy` for field-level visibility within types. > **Caution with non-null fields.** When privacy denies access, the field resolver returns `null`. If the field is typed as `Type::nonNull(...)`, this `null` violates the GraphQL non-null contract and causes an error that propagates up to the nearest nullable parent. Always use nullable types for privacy-protected fields. Query variables --------------- [](#query-variables) GraphQL offers you the possibility to use variables in your query so you don't need to "hardcode" value. This is done like that: ``` query FetchUserByID($id: String) { user(id: $id) { id email } } ``` When you query the GraphQL endpoint, you can pass a JSON encoded `variables` parameter. For example, using `curl`: ``` curl -X POST -H "Content-Type: application/json" \ -d '{"query": "query FetchUserByID($id: Int) { user(id: $id) { id email } }", "variables": {"id": 123}}' \ http://localhost:8000/graphql ``` Custom field ------------ [](#custom-field) You can also define a field as a class if you want to reuse it in multiple types. ``` declare(strict_types = 1); namespace App\GraphQL\Fields; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Field; class PictureField extends Field { protected $attributes = [ 'description' => 'A picture', ]; public function type(): Type { return Type::string(); } public function args(): array { return [ 'width' => [ 'type' => Type::int(), 'description' => 'The width of the picture' ], 'height' => [ 'type' => Type::int(), 'description' => 'The height of the picture' ] ]; } protected function resolve($root, array $args) { $width = isset($args['width']) ? $args['width']:100; $height = isset($args['height']) ? $args['height']:100; return 'https://placehold.co/'.$width.'x'.$height; } } ``` You can then use it in your type declaration ``` declare(strict_types = 1); namespace App\GraphQL\Types; use App\GraphQL\Fields\PictureField; use App\Models\User; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Type as GraphQLType; class UserType extends GraphQLType { protected $attributes = [ 'name' => 'User', 'description' => 'A user', 'model' => User::class, ]; public function fields(): array { return [ 'id' => [ 'type' => Type::nonNull(Type::string()), 'description' => 'The id of the user' ], 'email' => [ 'type' => Type::string(), 'description' => 'The email of user' ], //Instead of passing an array, you pass a class path to your custom field 'picture' => PictureField::class ]; } } ``` ### Even better reusable fields [](#even-better-reusable-fields) Instead of using the class name, you can also supply an actual instance of the `Field`. This allows you to not only re-use the field, but will also open up the possibility to re-use the resolver. Let's imagine we want a field type that can output dates formatted in all sorts of ways. ``` declare(strict_types = 1); namespace App\GraphQL\Fields; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Field; class FormattableDate extends Field { protected $attributes = [ 'description' => 'A field that can output a date in all sorts of ways.', ]; public function __construct(array $settings = []) { $this->attributes = \array_merge($this->attributes, $settings); } public function type(): Type { return Type::string(); } public function args(): array { return [ 'format' => [ 'type' => Type::string(), 'defaultValue' => 'Y-m-d H:i', 'description' => 'Defaults to Y-m-d H:i', ], 'relative' => [ 'type' => Type::boolean(), 'defaultValue' => false, ], ]; } protected function resolve($root, array $args): ?string { $date = $root->{$this->getProperty()}; if (!$date instanceof Carbon) { return null; } if ($args['relative']) { return $date->diffForHumans(); } return $date->format($args['format']); } protected function getProperty(): string { return $this->attributes['alias'] ?? $this->attributes['name']; } } ``` You can use this field in your type as follows: ``` declare(strict_types = 1); namespace App\GraphQL\Types; use App\GraphQL\Fields\FormattableDate; use App\Models\User; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Type as GraphQLType; class UserType extends GraphQLType { protected $attributes = [ 'name' => 'User', 'description' => 'A user', 'model' => User::class, ]; public function fields(): array { return [ 'id' => [ 'type' => Type::nonNull(Type::string()), 'description' => 'The id of the user' ], 'email' => [ 'type' => Type::string(), 'description' => 'The email of user' ], // You can simply supply an instance of the class 'dateOfBirth' => new FormattableDate, // Because the constructor of `FormattableDate` accepts our the array of parameters, // we can override them very easily. // Imagine we want our field to be called `createdAt`, but our database column // is called `created_at`: 'createdAt' => new FormattableDate([ 'alias' => 'created_at', ]) ]; } } ``` Dataloaders ----------- [](#dataloaders) Dataloaders are the standard GraphQL pattern for solving n+1 problems and are the recommended default data loading strategy. They use **deferred resolution**-- a mechanism built into [webonyx/graphql-php](https://webonyx.github.io/graphql-php/data-fetching/#solving-n1-problem), the GraphQL engine this library is built on. Dataloaders do not require Eloquent models or special type configuration, and they work with any data source. The pattern has two phases: 1. **Collect** -- each field resolver registers the key it needs (e.g. a user ID) and returns a `GraphQL\Deferred` instead of a value. 2. **Batch** -- once all non-deferred fields are resolved, the deferred callbacks fire. The first callback triggers a bulk fetch for all collected keys; the rest read from the already-loaded result. ### Creating a loader [](#creating-a-loader) A loader is a plain PHP class that accumulates keys and performs a single bulk query when triggered. Registering it as a [scoped singleton](https://laravel.com/docs/container#the-scoped-method) ensures a fresh instance per request (safe for Laravel Octane and queue workers). ``` declare(strict_types = 1); namespace App\GraphQL\Loaders; use App\Models\User; use GraphQL\Deferred; class UserLoader { /** @var list */ private array $pendingIds = []; /** @var array */ private array $loaded = []; /** * Register a key to be loaded and return a deferred resolver. */ public function load(int $id): Deferred { $this->pendingIds[] = $id; return new Deferred(function () use ($id): ?User { $this->loadPending(); return $this->loaded[$id] ?? null; }); } /** * Bulk-fetch all pending keys in a single query. */ private function loadPending(): void { $ids = array_diff(array_unique($this->pendingIds), array_keys($this->loaded)); $this->pendingIds = []; if ($ids === []) { return; } $users = User::whereIn('id', $ids)->get()->keyBy('id'); foreach ($users as $id => $user) { $this->loaded[$id] = $user; } } } ``` Register it in a service provider: ``` // AppServiceProvider::register() $this->app->scoped(\App\GraphQL\Loaders\UserLoader::class); ``` ### Using a loader in a type [](#using-a-loader-in-a-type) Resolve the loader from the container and call `load()` with the key. The returned `Deferred` is handled transparently by the GraphQL execution engine -- no changes to your schema, middleware, or controller are required. ``` declare(strict_types = 1); namespace App\GraphQL\Types; use App\GraphQL\Loaders\UserLoader; use App\Models\Post; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Facades\GraphQL; use Rebing\GraphQL\Support\Type as GraphQLType; class PostType extends GraphQLType { protected $attributes = [ 'name' => 'Post', 'description' => 'A blog post', ]; public function fields(): array { return [ 'id' => [ 'type' => Type::nonNull(Type::int()), ], 'title' => [ 'type' => Type::nonNull(Type::string()), ], 'author' => [ 'type' => GraphQL::type('User'), 'description' => 'The post author, loaded via dataloader', 'resolve' => function (Post $post) { return app(UserLoader::class)->load($post->author_id); }, ], ]; } } ``` If a query requests 50 posts, the `author` resolver is called 50 times -- but only one `SELECT * FROM users WHERE id IN (...)` query is executed, because all 50 IDs are collected during the "collect" phase and fetched together when the first `Deferred` callback fires. ### How it works [](#how-it-works) `GraphQL\Deferred` is a synchronous promise provided by webonyx/graphql-php. When a resolver returns a `Deferred`, the executor sets the value aside and continues resolving other fields. Once no more immediate fields remain, it drains the deferred queue: each callback runs, and if any callback returns another `Deferred`, that is queued too. This continues until all values are fully resolved. Because this library's execution middleware calls `GraphQL::executeQuery()` (which uses the built-in `SyncPromiseAdapter` internally), `Deferred` works out of the box with no additional configuration. ### Using a DataLoader library [](#using-a-dataloader-library) For applications with many loaders, the [overblog/dataloader-php](https://github.com/overblog/dataloader-php) library provides a higher-level `DataLoader` class with automatic request batching, per-request memoization, and cache priming. It ships with a webonyx/graphql-php sync promise adapter. For most Laravel applications the simple loader pattern shown above is sufficient, but `overblog/dataloader-php` can reduce boilerplate when you have dozens of entity types to batch-load. Eager loading relationships --------------------------- [](#eager-loading-relationships) > **Note:** The `SelectFields` class has been moved to the separate [`rebing/graphql-laravel-select-fields`](https://github.com/rebing/graphql-laravel-select-fields)package. Install it with `composer require rebing/graphql-laravel-select-fields`to use Eloquent-optimized field selection and eager loading in your resolvers. See the package's README for full documentation. JSON columns ------------ [](#json-columns) When using JSON columns in your database, the field won't be defined as a "relationship", but rather a simple column with nested data. If you use the [`rebing/graphql-laravel-select-fields`](https://github.com/rebing/graphql-laravel-select-fields)package, set the `is_relation` attribute to `false` in your Type to prevent SelectFields from treating it as an Eloquent relation: ``` class UserType extends GraphQLType { // ... public function fields(): array { return [ // ... // JSON column containing all posts made by this user 'posts' => [ 'type' => Type::listOf(GraphQL::type('Post')), 'description' => 'A list of posts written by the user', // Tells SelectFields this is not an Eloquent relation // The value defaults to true 'is_relation' => false ] ]; } // ... } ``` Field deprecation ----------------- [](#field-deprecation) Sometimes you would want to deprecate a field but still have to maintain backward compatibility until clients completely stop using that field. You can deprecate a field using [directive](https://www.graphql-tools.com/docs/generate-schema/#descriptions--deprecations). If you add `deprecationReason`to field attributes it will become marked as deprecated in GraphQL documentation. You can validate schema on client using [Apollo GraphOS](https://www.apollographql.com/docs/graphos/schema-design/schema-checks/). ``` declare(strict_types = 1); namespace App\GraphQL\Types; use App\Models\User; use GraphQL\Type\Definition\Type; use Rebing\GraphQL\Support\Type as GraphQLType; class UserType extends GraphQLType { protected $attributes = [ 'name' => 'User', 'description' => 'A user', 'model' => User::class, ]; public function fields(): array { return [ 'id' => [ 'type' => Type::nonNull(Type::string()), 'description' => 'The id of the user', ], 'email' => [ 'type' => Type::string(), 'description' => 'The email of user', ], 'address' => [ 'type' => Type::string(), 'description' => 'The address of user', 'deprecationReason' => 'Deprecated due to address field split' ], 'address_line_1' => [ 'type' => Type::string(), 'description' => 'The address line 1 of user', ], 'address_line_2' => [ 'type' => Type::string(), 'description' => 'The address line 2 of user', ], ]; } } ``` Default field resolver ---------------------- [](#default-field-resolver) It's possible to override the default field resolver provided by the underlying webonyx/graphql-php library using the config option `defaultFieldResolver`. You can define any valid callable (static class method, closure, etc.) for it: ``` 'defaultFieldResolver' => [Your\Klass::class, 'staticMethod'], ``` The parameters received are your regular "resolve" function signature. Macros ------ [](#macros) If you would like to define some helpers that you can re-use in a variety of your queries, mutations and types, you may use the macro method on the `GraphQL` facade. For example, from a service provider's boot method: ``` declare(strict_types = 1); namespace App\Providers; use GraphQL\Type\Definition\Type; use Illuminate\Support\ServiceProvider; use Rebing\GraphQL\Support\Facades\GraphQL; class AppServiceProvider extends ServiceProvider { /** * Bootstrap any application services. * * @return void */ public function boot() { GraphQL::macro('listOf', function (string $name): Type { return Type::listOf(GraphQL::type($name)); }); } } ``` The `macro` function accepts a name as its first argument, and a `Closure` as its second. Automatic Persisted Queries support ----------------------------------- [](#automatic-persisted-queries-support) Automatic Persisted Queries (APQ) improve network performance by sending smaller requests, with zero build-time configuration. APQ is disabled by default and can be enabled in the config via `apq.enable=true` or by setting the environment variable `GRAPHQL_APQ_ENABLE=true`. A persisted query is an ID or hash that can be generated on the client sent to the server instead of the entire GraphQL query string. This smaller signature reduces bandwidth utilization and speeds up client loading times. Persisted queries pair especially with GET requests, enabling the browser cache and integration with a CDN. Note that GET requests are disabled by default; to use APQ with GET, you must explicitly set `'method' => ['GET', 'POST']` in your schema configuration. Behind the scenes, APQ uses Laravel's cache for storing / retrieving the queries. They are parsed by GraphQL before storing, so re-parsing them again is not necessary. Please see the various options there for which cache, prefix, TTL, etc. to use. > Note: it is advised to clear the cache after a deployment to accommodate for changes in your schema! For more information see: - [Apollo - Automatic persisted queries](https://www.apollographql.com/docs/apollo-server/performance/apq/) - [Apollo Client - Persisted Query Link](https://www.apollographql.com/docs/react/api/link/persisted-queries/) > Note: the APQ protocol requires the hash sent by the client being compared with the computed hash on the server. In case a mutating middleware like `TrimStrings` is active and the query sent contains leading/trailing whitespaces, these hashes can never match resulting in an error. > > In such case either disable the middleware or trim the query on the client before hashing. ### Notes [](#notes) - The error descriptions are aligned with [apollo-server](https://github.com/apollographql/apollo-server). ### Client example [](#client-example) Below a simple integration example with Vue 3 and Apollo Client, where `createPersistedQueryLink`automatically manages the APQ flow. ``` // [example apollo.js] import { ApolloClient, InMemoryCache, HttpLink, ApolloLink } from '@apollo/client/core'; import { createPersistedQueryLink } from '@apollo/client/link/persisted-queries'; import { sha256 } from 'crypto-hash'; const httpLink = new HttpLink({ uri: '/graphql' }); const persistedQueryLink = createPersistedQueryLink({ sha256 }); export const apolloClient = new ApolloClient({ link: ApolloLink.from([persistedQueryLink, httpLink]), cache: new InMemoryCache(), connectToDevTools: true, }); ``` ``` Test APQ Loading... {{ result?.hello }} import { useQuery } from '@vue/apollo-composable'; import gql from 'graphql-tag'; const { result, loading } = useQuery(gql` query { hello } `); ``` Tracing / Observability ----------------------- [](#tracing--observability) GraphQL operations can be instrumented with timing data by configuring a tracing driver. Tracing is **disabled by default** (`'driver' => null`). The built-in `OpenTelemetryTracingDriver` emits spans via the OpenTelemetry API following the [GraphQL semantic conventions](https://opentelemetry.io/docs/specs/semconv/graphql/graphql-spans/). It requires the `open-telemetry/api` ^1.0 package. ### Enabling OpenTelemetry [](#enabling-opentelemetry) Install the OpenTelemetry API package first: ``` composer require open-telemetry/api ``` Then configure the driver: ``` 'tracing' => [ 'driver' => \Rebing\GraphQL\Support\Tracing\OpenTelemetryTracingDriver::class, 'driver_options' => [ // Include the GraphQL document in spans (may contain sensitive data) 'include_document' => true, ], ], ``` Without an OTel SDK configured, all spans are automatically no-ops. To actually collect and export spans, you need to install and configure the [OpenTelemetry PHP SDK](https://opentelemetry.io/docs/languages/php/sdk/) along with an [exporter](https://opentelemetry.io/docs/languages/php/exporters/) for your backend. The [Getting Started guide](https://opentelemetry.io/docs/languages/php/getting-started/)walks through a complete example. Once the SDK is configured, the driver automatically picks up the global `TracerProvider` - no additional wiring is needed in this package. ### Per-field resolver tracing [](#per-field-resolver-tracing) By default, only the top-level operation is traced. To instrument individual field resolvers, enable `field_tracing`: ``` 'tracing' => [ 'driver' => \Rebing\GraphQL\Support\Tracing\OpenTelemetryTracingDriver::class, 'field_tracing' => true, ], ``` With OpenTelemetry this creates a child span for each resolved field. When tracing is enabled (i.e. a `driver` is configured), the tracing execution and resolver middlewares (`TracingExecutionMiddleware` and `TracingResolverMiddleware`) are automatically registered - you do not need to add them to the `execution_middleware` or `resolver_middleware_append` config arrays manually. > **Note:** Field tracing produces high-cardinality data and is intended for development/debugging. Use it with caution in production. ### Custom tracing drivers [](#custom-tracing-drivers) You can implement the `Rebing\GraphQL\Support\Tracing\TracingDriver` interface to create your own driver. The interface has four methods: - `startOperation(schemaName, operationName, operationType, source)` - called before execution - `endOperation(context, ExecutionResult)` - called after execution; receives the opaque context from `startOperation` and may modify the result - `startFieldResolve(ResolveInfo)` - called before each field resolve (when field tracing is enabled) - `endFieldResolve(context, ResolveInfo)` - called after each field resolve Register your driver class in the `tracing.driver` config key and it will be resolved from the Laravel service container. If the driver constructor accepts an `array $driverOptions` parameter, it will receive the merged `driver_options`from the global and per-schema tracing config. ### Per-schema tracing [](#per-schema-tracing) By default, the global `tracing` configuration applies to every schema. You can override tracing on a per-schema basis by adding a `tracing` key inside the schema's config array. **Disable tracing for a specific schema:** ``` 'schemas' => [ 'internal' => [ 'query' => [/* ... */], 'tracing' => false, // no tracing for this schema ], ], ``` **Enable tracing only for a specific schema** (no global driver): ``` // Global: tracing disabled 'tracing' => [ 'driver' => null, ], 'schemas' => [ 'default' => [ 'query' => [/* ... */], // No 'tracing' key - inherits global (disabled) ], 'monitored' => [ 'query' => [/* ... */], 'tracing' => [ 'driver' => \Rebing\GraphQL\Support\Tracing\OpenTelemetryTracingDriver::class, 'field_tracing' => true, ], ], ], ``` **Override driver options per schema** (deep-merged over global): ``` // Global: tracing enabled, document excluded 'tracing' => [ 'driver' => \Rebing\GraphQL\Support\Tracing\OpenTelemetryTracingDriver::class, 'driver_options' => [ 'include_document' => false, ], ], 'schemas' => [ 'debug' => [ 'query' => [/* ... */], 'tracing' => [ 'field_tracing' => true, 'driver_options' => [ 'include_document' => true, // override for this schema only ], ], ], ], ``` Per-schema `tracing` arrays are deep-merged over the global config: schema values win for top-level keys, and `driver_options` is merged separately so you can override individual options without repeating the full array. Security -------- [](#security) GraphQL APIs have a different attack surface than REST APIs. A single endpoint accepts arbitrary queries, so without safeguards a client can craft deeply nested or highly complex queries that exhaust server resources. ### Introspection [](#introspection) Schema introspection lets clients discover your entire type system -- every query, mutation, field, and argument. This is essential for development tooling (GraphiQL, IDE plugins, codegen) but exposes your full API surface in production. Introspection is **disabled by default**: ``` // config/graphql.php 'security' => [ 'disable_introspection' => env('GRAPHQL_DISABLE_INTROSPECTION', true), ], ``` Set `GRAPHQL_DISABLE_INTROSPECTION=false` in your `.env` during development. ### Query depth limiting [](#query-depth-limiting) Deeply nested queries can cause excessive resolver calls and memory usage. The `query_max_depth` option rejects queries that exceed the allowed nesting level: ``` 'security' => [ 'query_max_depth' => 13, // default ], ``` For example, with a depth limit of 3, the query `{ users { posts { comments { author { name } } } } }` would be rejected because it nests 4 levels deep. Tune this based on your schema's legitimate nesting requirements. Start strict and increase only if real queries require it. ### Query complexity analysis [](#query-complexity-analysis) Complex queries (many fields, large lists) can be expensive even when shallow. The `query_max_complexity` option assigns a cost to each resolved field and rejects queries that exceed the budget: ``` 'security' => [ 'query_max_complexity' => 500, // default ], ``` You can assign custom complexity to individual fields using the `complexity`callback supported by webonyx/graphql-php: ``` 'posts' => [ 'type' => Type::listOf(GraphQL::type('Post')), 'complexity' => fn (int $childCost, array $args): int => $childCost * ($args['limit'] ?? 10), ], ``` See the [webonyx/graphql-php security documentation](https://webonyx.github.io/graphql-php/security/)for full details on how complexity is calculated. ### Batching limits [](#batching-limits) When [batching](#batching) is enabled, clients can send multiple operations in a single HTTP request. Without a cap, this can be used to amplify the impact of expensive queries. Batching is disabled by default, and when enabled the `batching.max_batch_size` option (default: `10`) limits the number of operations per request. ### GET requests and read-only enforcement [](#get-requests-and-read-only-enforcement) By default each schema only accepts `POST` (`'method' => ['POST']`). If you opt a schema in to `GET` (e.g. for CDN-cacheable persisted queries), enable the `ReadOnlyOperationMiddleware` execution middleware so that mutations and subscriptions submitted via `GET` are rejected. The middleware is shipped pre-listed (commented out) in the published config: ``` // config/graphql.php 'execution_middleware' => [ Rebing\GraphQL\Support\ExecutionMiddleware\ValidateOperationParamsMiddleware::class, Rebing\GraphQL\Support\ExecutionMiddleware\AutomaticPersistedQueriesMiddleware::class, Rebing\GraphQL\Support\ExecutionMiddleware\ReadOnlyOperationMiddleware::class, Rebing\GraphQL\Support\ExecutionMiddleware\AddAuthUserContextValueMiddleware::class, ], ``` Without this middleware, an operation submitted via `GET` is executed regardless of its type, which leaks mutation arguments into URLs, server access logs and CDN caches and bypasses defenses that assume `GET` is safe. This mirrors the protection that webonyx/graphql-php's `Server\Helper::executeOperation()` applies; we enforce it explicitly because the library calls `GraphQL::executeQuery()` directly. The rejection produces the standard GraphQL error `GET supports only query operation` with HTTP `200`. The middleware is opt-in so consumers running with the default `POST`-only configuration are unaffected. > **Ordering matters when APQ is enabled.** When used together with `AutomaticPersistedQueriesMiddleware`, list `ReadOnlyOperationMiddleware`*after* it (as shown above). APQ materialises the query body from the cache; running this middleware first against an APQ-only request would cause `OperationParams::getParsedQuery()` to throw `No GraphQL query available`. The ordering relative to `GraphqlExecutionMiddleware` is enforced by the framework, which always appends `GraphqlExecutionMiddleware` last. ### CSRF protection [](#csrf-protection) When your GraphQL endpoint uses cookie-based authentication (Laravel sessions, Sanctum cookie-mode), it is vulnerable to Cross-Site Request Forgery. A malicious page can submit a form POST to your `/graphql` endpoint and the browser will attach the session cookie automatically -- executing mutations on behalf of the logged-in user. This does **not** apply when authentication uses explicit credentials only (Bearer tokens, API keys) because browsers never attach those automatically. The `CsrfGuard` middleware protects against this by ensuring that every request either came from the same origin (verified via the browser's `Sec-Fetch-Site`header), or carries indicators that would have forced a CORS preflight (custom headers, non-simple Content-Type): ``` use Rebing\GraphQL\Support\Middleware\CsrfGuard; // config/graphql.php — apply to all schemas: 'route' => [ 'middleware' => [CsrfGuard::class], ], // Or per-schema with custom options: 'schemas' => [ 'admin' => [ 'middleware' => [CsrfGuard::class], // strict defaults ], 'public' => [ 'middleware' => [ CsrfGuard::using(strictWhenAmbiguous: false), // allow non-browser clients ], ], ], ``` The middleware is opt-in and has strict safe defaults. See the PHPDoc on `CsrfGuard::using()` for a full explanation of each configurable flag. ### Recommended production configuration [](#recommended-production-configuration) ``` // config/graphql.php 'security' => [ 'disable_introspection' => env('GRAPHQL_DISABLE_INTROSPECTION', true), 'query_max_depth' => 13, 'query_max_complexity' => 500, ], 'batching' => [ 'enable' => false, ], ``` Additional measures to consider at the infrastructure level: - **Rate limiting** -- Apply Laravel's `ThrottleRequests` middleware via `route.middleware` or per-schema `middleware` to limit requests per client. - **Request size limits** -- Configure your web server (Nginx `client_max_body_size`, Apache `LimitRequestBody`) to reject oversized request bodies. - **Timeout limits** -- Set PHP `max_execution_time` and web server timeouts to prevent long-running queries from holding connections open. - **Persisted queries** -- Enable [APQ](#automatic-persisted-queries-support) and, once warmed, consider rejecting ad-hoc queries entirely for maximum lockdown. Error handling -------------- [](#error-handling) This library has two distinct error layers: - **Errors** (`Rebing\GraphQL\Error\*`): Extend `GraphQL\Error\Error` from webonyx/graphql-php. These are **client-safe** and appear in GraphQL JSON responses. - **Exceptions** (`Rebing\GraphQL\Exception\*`): Extend `RuntimeException`. These indicate **configuration or developer errors** (e.g. a missing schema or unregistered type) and are not included in GraphQL responses. ### Built-in error types [](#built-in-error-types) ClassCategoryWhen thrown`ValidationError``validation`Argument validation rules fail (via `rules()` or inline `'rules'` key)`AuthorizationError``authorization``authorize()` returns anything other than `true``AutomaticPersistedQueriesError``apq`APQ hash mismatch, query not found, or APQ disabled### Error response format [](#error-response-format) Errors are returned in the standard GraphQL `errors` array. The library enriches each error with an `extensions` key: ``` { "errors": [ { "message": "validation", "extensions": { "category": "validation", "validation": { "email": ["The email field is required."] } }, "locations": [{"line": 1, "column": 20}] } ] } ``` For `AuthorizationError`, the response contains `extensions.category` set to `"authorization"` and the `message` from `getAuthorizationMessage()` (defaults to `"Unauthorized"`). ### Error reporting [](#error-reporting) The default `errors_handler` selectively reports errors to Laravel's exception handler: - `ValidationError` and `AuthorizationError` are **not reported** (they are expected application-level errors, not bugs). - GraphQL syntax/type errors (e.g. invalid queries) are **not reported**. - All other exceptions (unexpected errors, database failures, etc.) **are reported** through Laravel's `ExceptionHandler`, which typically logs them. ### Customizing error formatting [](#customizing-error-formatting) You can replace the default error formatter and/or error handler via config: ``` // config/graphql.php // Receives each GraphQL\Error\Error; must return an array 'error_formatter' => [App\GraphQL\ErrorFormatter::class, 'format'], // Receives all errors + the formatter; must return an array of formatted errors 'errors_handler' => [App\GraphQL\ErrorHandler::class, 'handle'], ``` The default formatter (`GraphQL::formatError`) respects `app.debug`: when debug mode is enabled, errors include `debugMessage` and `trace` fields for easier development. In production these are omitted. > **Tip:** Laravel's built-in `ValidationException` (thrown by `Validator::validate()`) is also handled by the default formatter -- it is automatically converted to the same `extensions.validation` format shown above. Misc features ------------- [](#misc-features) ### Detecting unused variables [](#detecting-unused-variables) By default, `'variables'` provided alongside the GraphQL query which are **not**consumed, are silently ignored. If you consider the hypothetical case you have an optional (nullable) argument in your query, and you provide a variable argument for it but you make a typo, this can go unnoticed. Example: ``` mutation test($value:ID) { someMutation(type:"falbala", optional_id: $value) } ``` Variables provided: ``` { // Ops! typo in `values` "values": "138" } ``` In this case, nothing happens and `optional_id` will be treated as not being provided. To prevent such scenarios, you can add the `UnusedVariablesMiddleware` to your `execution_middleware`. Configuration options --------------------- [](#configuration-options) OptionDefaultDescription`route.prefix``graphql`URL prefix for GraphQL endpoints (without leading `/`)`route.controller`Built-inOverride the default controller class (supports string and array format)`route.middleware``[]`Global HTTP middleware for all schemas (unless overridden per-schema)`route.group_attributes``[]`Additional route group attributes`default_schema``'default'`Name of the default schema when none is specified via the route`batching.enable``false`Enable/disable GraphQL [batching](#batching)`batching.max_batch_size``10`Max operations per batch (`null` for no limit)`error_formatter`Built-inCallable receiving each Error object; must return an array`errors_handler`Built-inCustom error handling; default passes exceptions to Laravel's error handler`security.query_max_complexity``500`Maximum allowed query complexity. See [graphql-php security docs](https://webonyx.github.io/graphql-php/security/)`security.query_max_depth``13`Maximum allowed query depth`security.disable_introspection``true`Disable schema introspection (env: `GRAPHQL_DISABLE_INTROSPECTION`)`pagination_type`Built-inCustom pagination type class`simple_pagination_type`Built-inCustom simple pagination type class`cursor_pagination_type`Built-inCustom cursor pagination type class`defaultFieldResolver``null`Override the [default field resolver](https://webonyx.github.io/graphql-php/data-fetching/#default-field-resolver)`headers``[]`Headers added to responses from the default controller`json_encoding_options``0`JSON encoding options for responses from the default controller`apq.enable``false`Enable [Automatic Persisted Queries](#automatic-persisted-queries-support)`apq.cache_driver`App defaultCache driver for APQ (defaults to your app's `cache.default` driver; env: `GRAPHQL_APQ_CACHE_DRIVER`)`apq.cache_prefix``'{cache.prefix}:graphql.apq'`Cache key prefix for persisted queries`apq.cache_ttl``300`Cache TTL in seconds for persisted queries`schemas`Defines available schemas and their settings. See [Schemas](#schemas)`schemas.*.query``[]`Array of query classes for this schema`schemas.*.mutation``[]`Array of mutation classes for this schema`schemas.*.types``[]`Array of type classes scoped to this schema`schemas.*.middleware`-Per-schema HTTP middleware (overrides `route.middleware`)`schemas.*.method``['POST']`HTTP methods to support (must be uppercase)`schemas.*.execution_middleware`-Per-schema execution middleware (overrides global `execution_middleware`)`schemas.*.route_attributes``[]`Additional Laravel route attributes (e.g. `domain`, `prefix`)`schemas.*.controller`-Override the controller for this schema`schemas.*.tracing`-Per-schema tracing overrides`types``[]`Global types shared across all schemas. See [Creating a query](#creating-a-query)`execution_middleware`Built-in setGlobal [execution middleware](#graphql-execution-middleware) classes. Terminal middleware is always appended automatically`resolver_middleware_append``null`Global [resolver middleware](#resolver-middleware) appended after per-field middleware`tracing.driver``null`Tracing driver class (`null` = disabled). Built-in: `OpenTelemetryTracingDriver`. See [Tracing](#tracing--observability)`tracing.field_tracing``false`Instrument individual field resolvers`tracing.driver_options``[]`Array of options passed to the driver constructor (e.g. `'include_document' => true`)Performance considerations -------------------------- [](#performance-considerations) ### Wrap Types [](#wrap-types) You can wrap types to add more information to the queries and mutations. Similar to how pagination works, you can do the same with your extra data that you want to inject. For instance, in your query: ``` public function type(): Type { return GraphQL::wrapType( 'PostType', 'PostMessageType', \App\GraphQL\Types\WrapMessagesType::class, ); } public function resolve($root, array $args) { return [ 'data' => Post::find($args['post_id']), 'messages' => new Collection([ new SimpleMessage("Congratulations, the post was found"), new SimpleMessage("This post cannot be edited", "warning"), ]), ]; } ``` #### Using wrap types with SelectFields [](#using-wrap-types-with-selectfields) If you use the [`rebing/graphql-laravel-select-fields`](https://github.com/rebing/graphql-laravel-select-fields)package with a query that returns a wrap type, your wrapper class must implement the `WrapType` marker interface from that package. See the SelectFields package documentation for details. Known limitations ----------------- [](#known-limitations) ### SelectFields related (see `rebing/graphql-laravel-select-fields`) [](#selectfields-related-see-rebinggraphql-laravel-select-fields) - Resolving fields via aliases will only resolve them once, even if the fields have different arguments ([Issue](https://github.com/rebing/graphql-laravel/issues/604)). GraphQL testing clients ----------------------- [](#graphql-testing-clients) You can interact with your GraphQL API using any of these clients: ClientNotes[GraphiQL](https://github.com/graphql/graphiql)The reference GraphQL IDE. Use the [laravel-graphiql](https://github.com/mll-lab/laravel-graphiql) package for seamless in-app integration (`/graphiql` route)[Altair](https://altairgraphql.dev/)Feature-rich desktop/browser client with file upload support, environments, and pre-request scripts[Postman](https://www.postman.com/)Has native GraphQL support with schema introspection, auto-complete, and variable management[Insomnia](https://insomnia.rest/)Lightweight REST/GraphQL client with schema fetching and query auto-complete[Bruno](https://www.usebruno.com/)Open-source, offline-first API client with GraphQL support. Collections are stored as files, making them easy to version control> **Tip:** Most of these clients rely on schema introspection. Introspection is disabled by default in this package. Set `GRAPHQL_DISABLE_INTROSPECTION=false`in your `.env` during development to enable it. Testing ------- [](#testing) You can test your GraphQL API using Laravel's built-in HTTP testing helpers. No additional packages are required. ### Querying an endpoint [](#querying-an-endpoint) Use `postJson` to send a GraphQL request and assert the response: ``` namespace Tests\Feature; use Tests\TestCase; class BooksQueryTest extends TestCase { public function test_can_query_books(): void { $response = $this->postJson('/graphql', [ 'query' => '{ books { id title author } }', ]); $response->assertOk() ->assertJsonStructure([ 'data' => [ 'books' => [ '*' => ['id', 'title', 'author'], ], ], ]); } } ``` ### Using query variables [](#using-query-variables) ``` public function test_can_fetch_user_by_id(): void { $response = $this->postJson('/graphql', [ 'query' => 'query FetchUser($id: String!) { user(id: $id) { id email } }', 'variables' => ['id' => '1'], ]); $response->assertOk() ->assertJsonPath('data.user.id', '1'); } ``` ### Testing mutations [](#testing-mutations) ``` public function test_can_update_user_password(): void { $response = $this->postJson('/graphql', [ 'query' => 'mutation { updateUserPassword(id: "1", password: "newpassword") { id } }', ]); $response->assertOk() ->assertJsonPath('data.updateUserPassword.id', '1'); } ``` ### Testing a non-default schema [](#testing-a-non-default-schema) Pass the schema name as part of the URL path: ``` public function test_user_schema_requires_auth(): void { $response = $this->postJson('/graphql/user', [ 'query' => '{ profile { id email } }', ]); $response->assertUnauthorized(); } ``` ### Asserting errors [](#asserting-errors) ``` public function test_authorization_rejects_guest(): void { $response = $this->postJson('/graphql', [ 'query' => '{ protectedQuery { id } }', ]); $response->assertOk() ->assertJsonPath('errors.0.message', 'Unauthorized'); } public function test_validation_returns_errors(): void { $response = $this->postJson('/graphql', [ 'query' => 'mutation { updateUserEmail(id: "", email: "not-an-email") { id } }', ]); $response->assertOk() ->assertJsonPath('errors.0.message', 'validation') ->assertJsonStructure([ 'errors' => [ ['extensions' => ['validation']], ], ]); } ``` > **Tip:** For database-backed tests, use Laravel's `RefreshDatabase` or `DatabaseTransactions` trait as you would in any feature test. Upgrading --------- [](#upgrading) For upgrade guides, see [UPGRADE.md](UPGRADE.md): - [Upgrading from 9 to 10](UPGRADE.md#upgrading-from-9-to-10) - [Upgrading from v1 to v2](UPGRADE.md#upgrading-from-v1-to-v2) Credits ------- [](#credits) This project was originally forked from [Folklore's laravel-graphql](https://github.com/folkloreinc/laravel-graphql). ### Health Score 82 — ExcellentBetter than 100% of packages Maintenance98 Actively maintained with recent releases Popularity73 Solid adoption and visibility Community47 Growing community involvement Maturity94 Battle-tested with a long release history Bus Factor1 Top contributor holds 82.6% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~33 days Recently: every ~22 days Total 103 Last Release 16d ago Major Versions 6.5.0 → 7.0.02021-04-03 7.2.0 → 8.0.0-rc12021-04-24 8.6.0 → 9.0.0-rc12023-03-05 8.x-dev → 9.0.0-rc22023-06-18 9.x-dev → 10.0.0-RC12026-03-18 PHP version history (8 changes)v1.4PHP >=5.5.9 v1.17.3PHP ^7.1 v2.0.0-RC2PHP >= 7.1 5.1.3PHP >= 7.2 8.3.0PHP >= 7.4 9.0.0-rc3PHP ^8.0 9.3.0PHP ^8.1 9.9.0PHP ^8.2 ### Community Maintainers ![](https://www.gravatar.com/avatar/4acecb37dd6c5733ab5d16a9e28b6e7cbd2ead45f824dc36d803230d9cd32c6c?d=identicon)[Rebing](/maintainers/Rebing) --- Top Contributors [![mfn](https://avatars.githubusercontent.com/u/87493?v=4)](https://github.com/mfn "mfn (1738 commits)")[![crissi](https://avatars.githubusercontent.com/u/3076578?v=4)](https://github.com/crissi "crissi (42 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (34 commits)")[![duncanmcclean](https://avatars.githubusercontent.com/u/19637309?v=4)](https://github.com/duncanmcclean "duncanmcclean (31 commits)")[![jasonvarga](https://avatars.githubusercontent.com/u/105211?v=4)](https://github.com/jasonvarga "jasonvarga (25 commits)")[![georgeboot](https://avatars.githubusercontent.com/u/884482?v=4)](https://github.com/georgeboot "georgeboot (22 commits)")[![illambo](https://avatars.githubusercontent.com/u/1899805?v=4)](https://github.com/illambo "illambo (22 commits)")[![sforward](https://avatars.githubusercontent.com/u/3530221?v=4)](https://github.com/sforward "sforward (17 commits)")[![sowork](https://avatars.githubusercontent.com/u/15050765?v=4)](https://github.com/sowork "sowork (17 commits)")[![stevelacey](https://avatars.githubusercontent.com/u/289531?v=4)](https://github.com/stevelacey "stevelacey (17 commits)")[![rebing](https://avatars.githubusercontent.com/u/8533161?v=4)](https://github.com/rebing "rebing (15 commits)")[![EdwinDayot](https://avatars.githubusercontent.com/u/3714657?v=4)](https://github.com/EdwinDayot "EdwinDayot (14 commits)")[![zjbarg](https://avatars.githubusercontent.com/u/26728749?v=4)](https://github.com/zjbarg "zjbarg (13 commits)")[![edgarsn](https://avatars.githubusercontent.com/u/6625918?v=4)](https://github.com/edgarsn "edgarsn (11 commits)")[![viktorruskai](https://avatars.githubusercontent.com/u/9396295?v=4)](https://github.com/viktorruskai "viktorruskai (9 commits)")[![matsn0w](https://avatars.githubusercontent.com/u/15019582?v=4)](https://github.com/matsn0w "matsn0w (8 commits)")[![alissn](https://avatars.githubusercontent.com/u/26966142?v=4)](https://github.com/alissn "alissn (7 commits)")[![alancolant](https://avatars.githubusercontent.com/u/19172637?v=4)](https://github.com/alancolant "alancolant (6 commits)")[![jacobdekeizer](https://avatars.githubusercontent.com/u/15017400?v=4)](https://github.com/jacobdekeizer "jacobdekeizer (6 commits)")[![kylekatarnls](https://avatars.githubusercontent.com/u/5966783?v=4)](https://github.com/kylekatarnls "kylekatarnls (6 commits)") --- Tags frameworklaravelgraphqlreact ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StylePHP CS Fixer Type Coverage Yes ### Embed Badge ![Health badge](/badges/rebing-graphql-laravel/health.svg) ``` [![Health](https://phpackages.com/badges/rebing-graphql-laravel/health.svg)](https://phpackages.com/packages/rebing-graphql-laravel) ``` ### Alternatives [nuwave/lighthouse A framework for serving GraphQL from Laravel 3.5k11.8M117](/packages/nuwave-lighthouse)[laravel/horizon Dashboard and code-driven configuration for Laravel queues. 4.2k95.4M306](/packages/laravel-horizon)[laravel/sail Docker files for running a basic Laravel application. 1.9k205.7M1.3k](/packages/laravel-sail)[laravel/ai The official AI SDK for Laravel. 1.0k3.2M194](/packages/laravel-ai)[laravel/socialite Laravel wrapper around OAuth 1 & OAuth 2 libraries. 5.7k108.5M885](/packages/laravel-socialite)[laravel/mcp Rapidly build MCP servers for your Laravel applications. 77022.3M151](/packages/laravel-mcp) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)