Developed with love by KnpLabs Hire us for your project!
65

GraphiQLBundle

by overblog

This Symfony Bundle provides GraphiQL interface for your project

OverblogGraphiQLBundle

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

The MIT License (MIT)

Copyright (c) Overblog

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
overblog_graphiql:
endpoint_resolver: Overblog\GraphiQLBundle\Config\GraphQLEndpoint\Helpers\OverblogGraphQLBundleEndpointResolver

# In case you need it's possible to replace GraphiQL twig template
template: @OverblogGraphiQL/GraphiQL/index.html.twig
javascript_libraries:
graphiql: 0.11
react: 15.6
fetch: 2.0
  • Merge pull request #24 from htulipe/js-lib-versions
    By web-flow, 5 months ago
  • Support React v16 and fetch v3
    By , 5 months ago
  • Use perl replace to switch between Symfony versions
    By mcg-web, 7 months ago
  • Add Symfony 5.0 Support (#23)
    By mcg-web, 7 months ago
  • Merge pull request #22 from mcg-web/support_symfony_4_2
    By web-flow, 1 year ago
  • Optimize travis config and add php 7.3 / symfony 4.2 build
    By mcg-web, 1 year ago
  • Support Symfony 4.2
    By mcg-web, 1 year ago
  • Merge pull request #16 from xkobal/master
    By web-flow, 2 years ago
  • Update services.xml
    By web-flow, 2 years ago
  • Update routing.xml
    By web-flow, 2 years ago
  • Merge pull request #17 from Destroy666x/AddParametersBlock
    By web-flow, 2 years ago
  • Add GraphiQL parameters Twig block
    By Przemek Pawlas, 2 years ago
  • User Deprecated: Referencing controllers with a single colon is deprecated since Symfony 4.1. Use overblog_graphql.controller.graphql::indexAction instead.
    By web-flow, 2 years ago
  • Merge pull request #14 from alafon/configurable-endpoint-manager
    By web-flow, 2 years ago
  • Giving :heart: to phpcs
    By alafon, 2 years ago
  • Documentation
    By alafon, 2 years ago
  • Make it possible to configure a endpoint resolver for graphiql
    By alafon, 2 years ago
  • Fix travis build
    By mcg-web, 2 years ago
  • Update documentation for Symfony 4
    By web-flow, 2 years ago
  • Merge pull request #11 from ruudk/patch-1
    By web-flow, 2 years ago
  • Travis: Running less builds and keeping code coverage only in one
    By renatomefi, 2 years ago
  • Travis > Test PHP 7.2
    By web-flow, 2 years ago
  • Merge pull request #7 from renatomefi/doc/extended
    By web-flow, 2 years ago
  • Merge pull request #8 from renatomefi/feature/remove-relay-version-option
    By web-flow, 2 years ago
  • [Documentation] Relay version isn't available anymore
    By renatomefi, 2 years ago
  • Documentation: Added custom headers and libraries versions
    By renatomefi, 2 years ago
  • [Configuration] Removed relay version option
    By renatomefi, 2 years ago
  • Fixing dev-master branch version on composer
    By web-flow, 2 years ago
  • Merge pull request #6 from renatomefi/documentation/basic
    By web-flow, 2 years ago
  • Documentation: Added Symfony Standard installation
    By renatomefi, 2 years ago