PHPackages beeeye/lumen-graphql - 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. beeeye/lumen-graphql ActiveLibrary[Framework](/categories/framework) beeeye/lumen-graphql ==================== Facebook GraphQL for lumen 1.0.0(7y ago)158MITPHPPHP >=5.5.9 Since Mar 9Pushed 7y agoCompare [ Source](https://github.com/SZVince/lumen-graphql)[ Packagist](https://packagist.org/packages/beeeye/lumen-graphql)[ RSS](/packages/beeeye-lumen-graphql/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependencies (2)Versions (2)Used By (0) Lumen GraphQL ============= [](#lumen-graphql) Installation ------------ [](#installation) #### Dependencies: [](#dependencies) - [Laravel 5.x](https://github.com/laravel/laravel) or [Lumen](https://github.com/laravel/lumen) - [GraphQL PHP](https://github.com/webonyx/graphql-php) **1-** Require the package via Composer. ``` $ composer require beeeye/lumen-graphql ``` ### Lumen [](#lumen) **1-** Load the service provider in `bootstrap/app.php` ``` $app->register(BeeEye\GraphQL\LumenServiceProvider::class); ``` **2-** For using the facade you have to uncomment the line `$app->withFacades();` in `bootstrap/app.php` After uncommenting this line you have the `GraphQL` facade enabled ``` $app->withFacades(); ``` **3-** Publish the configuration file ``` $ php artisan graphql:publish ``` **4-** Load configuration file in `bootstrap/app.php` *Important*: this command needs to be executed before the registration of the service provider ``` $app->configure('graphql'); ... $app->register(BeeEye\GraphQL\LumenServiceProvider::class); ``` **5-** Review the configuration file ``` config/graphql.php ``` Documentation ------------- [](#documentation) Usage ----- [](#usage) - [Schemas](#schemas) - [Creating a query](#creating-a-query) - [Creating a mutation](#creating-a-mutation) - [Adding validation to mutation](#adding-validation-to-mutation) #### Advanced Usage [](#advanced-usage) - [Query variables](docs/advanced.md#query-variables) - [Query nested resource](docs/advanced.md#query-nested-resource) - [Enums](docs/advanced.md#enums) - [Interfaces](docs/advanced.md#interfaces) - [Custom field](docs/advanced.md#custom-field) - [Eager loading relationships](docs/advanced.md#eager-loading-relationships) ### Schemas [](#schemas) Starting from version 1.0, you can define multiple schemas. Having multiple schemas can be useful if, for example, you want an endpoint that is public and another one that needs authentication. You can define multiple schemas in the config: ``` 'schema' => 'default', 'schemas' => [ 'default' => [ 'query' => [ //'users' => 'App\GraphQL\Query\UsersQuery' ], 'mutation' => [ //'updateUserEmail' => 'App\GraphQL\Query\UpdateUserEmailMutation' ] ], 'secret' => [ 'query' => [ //'users' => 'App\GraphQL\Query\UsersQuery' ], 'mutation' => [ //'updateUserEmail' => 'App\GraphQL\Query\UpdateUserEmailMutation' ] ] ] ``` Or you can add schema using the facade: ``` GraphQL::addSchema('secret', [ 'query' => [ 'users' => 'App\GraphQL\Query\UsersQuery' ], 'mutation' => [ 'updateUserEmail' => 'App\GraphQL\Query\UpdateUserEmailMutation' ] ]); ``` Afterwards, you can build the schema using the facade: ``` // Will return the default schema defined by 'schema' in the config $schema = GraphQL::schema(); // Will return the 'secret' schema $schema = GraphQL::schema('secret'); // Will build a new schema $schema = GraphQL::schema([ 'query' => [ //'users' => 'App\GraphQL\Query\UsersQuery' ], 'mutation' => [ //'updateUserEmail' => 'App\GraphQL\Query\UpdateUserEmailMutation' ] ]); ``` Or you can request the endpoint for a specific schema ``` // Default schema http://homestead.app/graphql?query=query+FetchUsers{users{id,email}} // Secret schema http://homestead.app/graphql/secret?query=query+FetchUsers{users{id,email}} ``` ### Creating a query [](#creating-a-query) First you need to create a type. ``` namespace App\GraphQL\Type; use GraphQL\Type\Definition\Type; use BeeEye\GraphQL\Support\Type as GraphQLType; class UserType extends GraphQLType { protected $attributes = [ 'name' => 'User', 'description' => 'A user' ]; /* * Uncomment following line to make the type input object. * http://graphql.org/learn/schema/#input-types */ // protected $inputObject = true; public function fields() { return [ 'id' => [ 'type' => Type::nonNull(Type::string()), 'description' => 'The id of the user' ], 'email' => [ 'type' => Type::string(), 'description' => 'The email of user' ] ]; } // If you want to resolve the field yourself, you can declare a method // with the following format resolve[FIELD_NAME]Field() protected function resolveEmailField($root, $args) { return strtolower($root->email); } } ``` Add the type to the `config/graphql.php` configuration file ``` 'types' => [ 'User' => 'App\GraphQL\Type\UserType' ] ``` You could also add the type with the `GraphQL` Facade, in a service provider for example. ``` GraphQL::addType('App\GraphQL\Type\UserType', 'User'); ``` 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. ``` namespace App\GraphQL\Query; use GraphQL; use GraphQL\Type\Definition\Type; use BeeEye\GraphQL\Support\Query; use App\User; class UsersQuery extends Query { protected $attributes = [ 'name' => 'users' ]; public function type() { return Type::listOf(GraphQL::type('User')); } public function args() { return [ 'id' => ['name' => 'id', 'type' => Type::string()], 'email' => ['name' => 'email', 'type' => Type::string()] ]; } public function resolve($root, $args) { if (isset($args['id'])) { return User::where('id' , $args['id'])->get(); } else if(isset($args['email'])) { return User::where('email', $args['email'])->get(); } else { return User::all(); } } } ``` Add the query to the `config/graphql.php` configuration file ``` 'schemas' => [ 'default' => [ 'query' => [ 'users' => 'App\GraphQL\Query\UsersQuery' ], // ... ] ] ``` And that's it. You should be able to query GraphQL with a request to the url `/graphql` (or anything you choose in your config). Try a GET request with the following `query` input ``` query FetchUsers { users { id email } } ``` For example, if you use homestead: ``` http://homestead.app/graphql?query=query+FetchUsers{users{id,email}} ``` ### Creating a mutation [](#creating-a-mutation) A mutation is like any other query, it accepts arguments (which will be used to do the mutation) and return an object of a certain type. For example a mutation to update the password of a user. First you need to define the Mutation. ``` namespace App\GraphQL\Mutation; use GraphQL; use GraphQL\Type\Definition\Type; use BeeEye\GraphQL\Support\Mutation; use App\User; class UpdateUserPasswordMutation extends Mutation { protected $attributes = [ 'name' => 'updateUserPassword' ]; public function type() { return GraphQL::type('User'); } public function args() { return [ 'id' => ['name' => 'id', 'type' => Type::nonNull(Type::string())], 'password' => ['name' => 'password', 'type' => Type::nonNull(Type::string())] ]; } public function resolve($root, $args) { $user = User::find($args['id']); if (!$user) { return null; } $user->password = bcrypt($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 then add the mutation to the `config/graphql.php` configuration file ``` 'schema' => [ 'default' => [ 'mutation' => [ 'updateUserPassword' => 'App\GraphQL\Mutation\UpdateUserPasswordMutation' ], // ... ] ] ``` You should then be able to use the following query on your endpoint to do the mutation. ``` mutation users { updateUserPassword(id: "1", password: "newpassword") { id email } } ``` if you use homestead: ``` http://homestead.app/graphql?query=mutation+users{updateUserPassword(id: "1", password: "newpassword"){id,email}} ``` #### Adding validation to mutation [](#adding-validation-to-mutation) It is possible to add validation rules to mutation. It uses the laravel `Validator` to performs validation against the `args`. When creating a mutation, you can add a method to define the validation rules that apply by doing the following: ``` namespace App\GraphQL\Mutation; use GraphQL; use GraphQL\Type\Definition\Type; use BeeEye\GraphQL\Support\Mutation; use App\User; class UpdateUserEmailMutation extends Mutation { protected $attributes = [ 'name' => 'UpdateUserEmail' ]; public function type() { return GraphQL::type('User'); } public function args() { return [ 'id' => ['name' => 'id', 'type' => Type::string()], 'email' => ['name' => 'email', 'type' => Type::string()] ]; } public function rules() { return [ 'id' => ['required'], 'email' => ['required', 'email'] ]; } public function resolve($root, $args) { $user = User::find($args['id']); if (!$user) { return null; } $user->email = $args['email']; $user->save(); return $user; } } ``` Alternatively you can define rules with each args ``` class UpdateUserEmailMutation extends Mutation { //... public function args() { return [ 'id' => [ 'name' => 'id', 'type' => Type::string(), 'rules' => ['required'] ], 'email' => [ 'name' => 'email', 'type' => Type::string(), 'rules' => ['required', 'email'] ] ]; } //... } ``` When you execute a mutation, it will returns the validation errors. Since GraphQL specifications define a certain format for errors, the validation errors messages are added to the error object as a extra `validation` attribute. To find the validation error, you should check for the error with a `message` equals to `'validation'`, then the `validation` attribute will contain the normal errors messages returned by the Laravel Validator. ``` { "data": { "updateUserEmail": null }, "errors": [ { "message": "validation", "locations": [ { "line": 1, "column": 20 } ], "validation": { "email": [ "The email is invalid." ] } } ] } ``` ### Health Score 25 — LowBetter than 37% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity10 Limited adoption so far Community2 Small or concentrated contributor base Maturity55 Maturing project, gaining track record 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 Unknown Total 1 Last Release 2620d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/7d33ca9ebfe47fac377dd3dbfbc78f0a58847af92382a36fd7e3cf6e3ff15953?d=identicon)[SZVince](/maintainers/SZVince) --- Tags frameworkgraphqllumenreact ### Embed Badge ![Health badge](/badges/beeeye-lumen-graphql/health.svg) ``` [![Health](https://phpackages.com/badges/beeeye-lumen-graphql/health.svg)](https://phpackages.com/packages/beeeye-lumen-graphql) ``` ### Alternatives [rebing/graphql-laravel Laravel wrapper for PHP GraphQL 2.2k7.1M26](/packages/rebing-graphql-laravel)[laravel-lang/publisher Localization publisher for your Laravel application 2167.7M24](/packages/laravel-lang-publisher)[railt/railt The Railt GraphQL Framework 3592.7k3](/packages/railt-railt) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)