overblog/graphiql-bundle

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

Installs: 4 370 979

Dependents: 19

Suggesters: 1

Security: 0

Stars: 77

Watchers: 9

Forks: 27

Open Issues: 8

Type:symfony-bundle

v1.0.0 2024-11-22 10:12 UTC

This package is auto-updated.

Last update: 2024-12-22 10:33:42 UTC


README

This Symfony bundle provides integration of GraphiQL interface to your Symfony application

Build Status Coverage Status Latest Stable Version Latest Unstable Version Total Downloads

Installation

a) Download the bundle

In the project directory:

composer require --dev overblog/graphiql-bundle

Symfony Flex installation

Note If you are using Symfony Standard go to the next section

a) Accept the contrib recipes installation from Symfony Flex

-  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

In the project directory:

composer require twig

If you are using twig ONLY for graphiql you might want to use --dev during composer require

Symfony Standard installation

a) Enable the bundle in the 'dev' section

// 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

# 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

More

Community

Contributing