2017 © Pedro Peláez
 

ezplatform-bundle ezplatform-graphql-bundle

GraphQL server for the eZ Platform Open Source CMS Repository.

image

bdunogier/ezplatform-graphql-bundle

GraphQL server for the eZ Platform Open Source CMS Repository.

  • Thursday, July 19, 2018
  • by bdunogier
  • Repository
  • 1 Watchers
  • 9 Stars
  • 140 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 3 Forks
  • 6 Open issues
  • 9 Versions
  • 31 % Grown

The README.md

eZ Platform GraphQL Bundle

This Symfony bundle adds a GraphQL server to eZ Platform, the Open Source CMS. It exposes two endpoints., (*1)

The domain schema: /graphql

https://<host>/graphql, (*2)

A graph of the repository's domain. It exposes the domain modelled using the repository, based on content types groups, content types and fields definitions. Use it to implement apps or sites dedicated to a given repository structure., (*3)

Example: an eZ Platform site., (*4)

Warning: this feature requires extra configuration steps. See the Domain Schema documentation., (*5)

The repository schema: /graphql/repository

https://<host>/graphql/repository, (*6)

A graph of the repository's Public API. It exposes value objects from the repository: content, location, field, url alias... It is recommended for admin like applications, not limited to a particular repository., (*7)

Example: an eZ Platform Admin UI extension., (*8)

Repository schema documentation, (*9)

Installation

Install the package and its dependencies using composer:, (*10)

composer require ezsystems/ezplatform-graphql

Add the bundles to app/AppKernel.php (pay attention to the order, it is important):, (*11)

$bundles = array(
    // ...
    new BD\EzPlatformGraphQLBundle\BDEzPlatformGraphQLBundle(),
    new Overblog\GraphQLBundle\OverblogGraphQLBundle(),
    new AppBundle\AppBundle(),
);

Add the GraphQL routing configuration to app/config/routing.yml:, (*12)

overblog_graphql:
    resource: "@OverblogGraphQLBundle/Resources/config/routing/graphql.yml"

overblog_graphql_endpoint:
    path: /graphql
    defaults:
        _controller: Overblog\GraphQLBundle\Controller\GraphController::endpointAction
        _format: "json"

Generate your schema

Run the command that generates the GraphQL schema:, (*13)

php bin/console ezplatform:graphql:generate-schema
php bin/console cache:clear

It will generate a lot of yaml files in app/config/graphql/ezplatform, based on your content types., (*14)

GraphiQL

The graphical graphQL client, GraphiQL, must be installed separately if you want to use it. As a developer, you probably want to., (*15)

composer require --dev overblog/graphiql-bundle

Add OverblogGraphiQLBundle to the dev bundles:, (*16)

case 'dev':
    // ...
    $bundles[] = new Overblog\GraphiQLBundle\OverblogGraphiQLBundle();

Add the GraphiQL route to app/config/routing_dev.yml:, (*17)

overblog_graphql_graphiql:
    resource: "@OverblogGraphiQLBundle/Resources/config/routing.xml"

Open http://<yourhost>/graphiql., (*18)

The Versions

19/07 2018

dev-master

9999999-dev

GraphQL server for the eZ Platform Open Source CMS Repository.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bertrand Dunogier

23/06 2018

dev-fix_image_variations

dev-fix_image_variations

GraphQL server for the eZ Platform Open Source CMS Repository.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bertrand Dunogier

18/06 2018

dev-fix_interfaces

dev-fix_interfaces

GraphQL server for the eZ Platform Open Source CMS Repository.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bertrand Dunogier

15/06 2018

dev-domain_content

dev-domain_content

GraphQL server for the eZ Platform Open Source CMS Repository.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bertrand Dunogier

14/06 2018

dev-relay

dev-relay

GraphQL server for the eZ Platform Open Source CMS Repository.

  Sources   Download

MIT

The Requires

 

by Bertrand Dunogier

08/06 2018

dev-upgrade_libraries

dev-upgrade_libraries

GraphQL server for the eZ Platform Open Source CMS Repository.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bertrand Dunogier

05/06 2018

v0.1.0

0.1.0.0

GraphQL server for the eZ Platform Open Source CMS Repository.

  Sources   Download

MIT

The Requires

 

by Bertrand Dunogier

04/04 2017

dev-repository_forms_mutations

dev-repository_forms_mutations

GraphQL server for the eZ Platform Open Source CMS Repository.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Bertrand Dunogier

20/10 2016

dev-query_types

dev-query_types

GraphQL server for the eZ Platform Open Source CMS Repository.

  Sources   Download

MIT

The Requires

 

by Bertrand Dunogier