overblog/graphiql-bundle

Symfony GraphiQLBundle makes possible to render the UI into your symfony project

OverblogGraphiQLBundle

This Symfony bundle provides integration of GraphiQL interface to your Symfony application, _(*1)

, _(*2)

Installation

a) Download the bundle, _(*3)

In the project directory:, _(*4)

composer require --dev overblog/graphiql-bundle

Symfony Flex installation

Note If you are using Symfony Standard go to the next section, _(*5)

a) Accept the contrib recipes installation from Symfony Flex, _(*6)

-  WARNING  overblog/graphiql-bundle (0.1): From github.com/symfony/recipes-contrib
    The recipe for this package comes from the "contrib" repository, which is open to community contributions.
    Do you want to execute this recipe?
    [y] Yes
    [n] No
    [a] Yes for all packages, only for the current installation session
    [p] Yes permanently, never ask again for this project
    (defaults to n):

b) In case you don't have twig, _(*7)

In the project directory:, _(*8)

composer require twig

If you are using twig ONLY for graphiql you might want to use --dev during composer require, _(*9)

Symfony Standard installation

a) Enable the bundle in the 'dev' section, _(*10)

// in app/AppKernel.php
class AppKernel extends Kernel
{
    // ...

    public function registerBundles()
    {
        if (in_array($this->getEnvironment(), array('dev', 'test'))) {
            // ...
            $bundles[] = new Overblog\GraphiQLBundle\OverblogGraphiQLBundle();
        }
    }
}

b) Enable GraphiQL endpoint, _(*11)

# in app/config/routing_dev.yml
overblog_graphiql_endpoint:
    resource: "@OverblogGraphiQLBundle/Resources/config/routing.xml"

Done

It's done now, navigate to /graphiql in your project url, _(*12)

More

• Custom HTTP headers
• Custom page rendering
• Custom GraphiQL parameters
• Define JavaScript libraries' versions
• Define a custom GraphQL endpoint

Community

• Get some support on Symfony devs Slack on the dedicated channel overblog-graphql.
• Follow us on GitHub

Contributing

• See contributing documentation
• Thanks to all contributors