digiaonline/lumen-graphql

GraphQL module for the Laravel and Lumen PHP frameworks.

Lumen GraphQL

, _(*1)

GraphQL module for the Laravel and Lumen PHP frameworks., _(*2)

Requirements

• PHP 7.1 or newer
• Composer
• Lumen / Laravel 5.5 or newer

Usage

Installation

Run the following command to install the package through Composer:, _(*3)

composer require digiaonline/lumen-graphql

Configure

Copy the configuration template in config/graphql.php to your application's config directory and modify according to your needs. For more information see the Configuration Files section in the Lumen documentation., _(*4)

Available configuration options:, _(*5)

• schema string Schema class name, must be an instance of Youshido\GraphQL\Schema\Schema
• type_resolver string Type resolver class name, must be an instance of Digia\Lumen\GraphQL\Contracts\TypeResolverInterface
• processor string Optional processor class name, must be an instance of Youshido\GraphQL\Execution\Processor
• enable_graphiql bool Whether or not the GraphiQL interface is enabled
• graphiql_token string Token required for accessing the GraphiQL interface

Bootstrapping

Add the following line to bootstrap/app.php:, _(*6)

$app->register(Digia\Lumen\GraphQL\GraphQLServiceProvider::class);

Add the following lines to routes/web.php:, _(*7)

$router->get('/graphql', [
    'uses' => 'Digia\Lumen\GraphQL\Http\GraphQLController@renderGraphiQL',
]);

$router->post('/graphql', [
    'uses' => 'Digia\Lumen\GraphQL\Http\GraphQLController@handle',
]);

NOTE: Make sure that your route group does not have a namespace attribute. Otherwise Lumen will be unable to find the GraphQLController., _(*8)

Contributing

Please read the guidelines., _(*9)

License

See LICENSE., _(*10)