Skip to main content
Version: 3.0

Getting started with Symfony

The GraphQLite bundle is compatible with Symfony 4.x.

The Symfony Flex recipe is not yet available.

Installation‚Äč

Open a terminal in your current project directory and run:

$ composer require thecodingmachine/graphqlite-bundle

Enable the library by adding it to the list of registered bundles in the app/AppKernel.php file:

app/AppKernel.php

<?php

class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = array(
// other bundles...
new TheCodingMachine\GraphQLite\Bundle\GraphQLiteBundle,
);
}
}

Now, enable the "graphql/" route by editing the config/routes.yaml file:

config/routes.yaml

# Add these 2 lines to config/routes.yaml
graphqlite_bundle:
resource: '@GraphqliteBundle/Resources/config/routes.xml'

Last but not least, create the configuration file at config/packages/graphqlite.yaml:

config/packages/graphqlite.yaml

graphqlite:
namespace:
# The namespace(s) that will store your GraphQLite controllers.
# It accept either a string or a list of strings.
controllers: App\Controller\
# The namespace(s) that will store your GraphQL types and factories.
# It accept either a string or a list of strings.
types:
- App\Types\
- App\Entity\
debug:
# Include exception messages in output when an error arises.
INCLUDE_DEBUG_MESSAGE: false
# Include stacktrace in output when an error arises.
INCLUDE_TRACE: false
# Exceptions are not caught by the engine and propagated to Symfony.
RETHROW_INTERNAL_EXCEPTIONS: false
# Exceptions that do not implement ClientAware interface are
# not caught by the engine and propagated to Symfony.
RETHROW_UNSAFE_EXCEPTIONS: true

The debug parameters are detailed in the documentation of the Webonyx GraphQL library which is used internally by GraphQLite.