overblog/graphql-bundle

This bundle provides tools to build a GraphQL server in your Symfony App.

v1.5.0 2024-07-01 13:58 UTC

Requires

• php: ^8.0
• ext-json: *
• murtukov/php-code-generator: ^0.1.5
• phpdocumentor/reflection-docblock: ^5.2
• phpdocumentor/type-resolver: ^1.6.1
• psr/log: ^1.0 || ^2.0 || ^3.0
• symfony/config: ^5.4 || ^6.0 || ^7.0
• symfony/dependency-injection: ^5.4 || ^6.0 || ^7.0
• symfony/event-dispatcher: ^5.4 || ^6.0 || ^7.0
• symfony/expression-language: ^5.4 || ^6.0 || ^7.0
• symfony/framework-bundle: ^5.4 || ^6.0 || ^7.0
• symfony/http-foundation: ^5.4 || ^6.0 || ^7.0
• symfony/http-kernel: ^5.4 || ^6.0 || ^7.0
• symfony/options-resolver: ^5.4 || ^6.0 || ^7.0
• symfony/property-access: ^5.4 || ^6.0 || ^7.0
• webonyx/graphql-php: ^15.4

Requires (Dev)

• doctrine/annotations: ^1.13
• doctrine/orm: ^2.5
• monolog/monolog: ^2.8.0 || ^3.0
• phpstan/extension-installer: ^1.0
• phpstan/phpstan: 1.8.4
• phpstan/phpstan-phpunit: ^1.0
• phpstan/phpstan-symfony: ^1.0
• phpunit/phpunit: ^9.5.10
• react/promise: ^2.5
• symfony/asset: ^5.4 || ^6.0 || ^7.0
• symfony/browser-kit: ^5.4 || ^6.0 || ^7.0
• symfony/console: ^5.4 || ^6.0 || ^7.0
• symfony/css-selector: ^5.4 || ^6.0 || ^7.0
• symfony/dom-crawler: ^5.4 || ^6.0 || ^7.0
• symfony/finder: ^5.4 || ^6.0 || ^7.0
• symfony/monolog-bundle: ^3.7
• symfony/phpunit-bridge: ^6.0
• symfony/process: ^5.4 || ^6.0 || ^7.0
• symfony/routing: ^5.4 || ^6.0 || ^7.0
• symfony/security-bundle: ^5.4 || ^6.0 || ^7.0
• symfony/validator: ^5.4 || ^6.0 || ^7.0
• symfony/var-dumper: ^5.4 || ^6.0 || ^7.0
• symfony/yaml: ^5.4 || ^6.0 || ^7.0
• twig/twig: ^2.10|^3.0

Suggests

• nelmio/cors-bundle: For more flexibility when using CORS prefight
• overblog/graphiql-bundle: If you want to use graphiQL.
• react/promise: To use ReactPHP promise adapter
• symfony/translation: If you want validation error messages to be translated.

Conflicts

• react/promise: <2.8

MIT

• Overblog

• graphql
• Relay

README

OverblogGraphQLBundle

This Symfony bundle provides integration of GraphQL using webonyx/graphql-php and GraphQL Relay. It also supports:

• batching with ReactRelayNetworkLayer
• batching with Apollo GraphQL
• upload and batching upload with apollo-upload-client

Browse your version documentation:

• 1.0 (DEV)
• 0.14 (STABLE)
• 0.13 (STABLE)
• 0.12 (DEPRECATE)
• 0.11 (OBSOLETE)
• 0.10 (OBSOLETE)
• 0.9 (OBSOLETE)
• 0.8 (OBSOLETE)

Versions requirements

Proof of Concept

• mcg-web/graphql-symfony-doctrine-sandbox
• michaelperrin/blog-graphql-upload-demo
• overblog/GraphQLBundleDemo
• Samffy/graphql-poc

Documentation

• Quick start
• Installation
• Definitions
  • Type System
    • Scalars
    • Object
    • Interface
    • Union
    • Enum
    • Input Object
    • Lists
    • Non-Null
  • Type Inheritance
  • GraphQL schema language
  • Schema
  • Resolver
  • Experimental coroutine executor
  • Solving N+1 problem
  • Mutation
  • Relay
    • Connection
      • Relay Pagination helper
    • Node
      • Node
      • Plural
      • Global id
    • Mutation
  • Builders
    • Field Builder
    • Fields Builder
    • Args Builder
  • Expression language
  • Debug
  • GraphiQL
  • Upload files
• Data fetching
  • Query batching
  • Promise
• Attributes
• Validation
• Security
  • Handle CORS
  • Object access control
  • Fields access control
  • Fields public control
  • Limiting query depth
  • Query complexity analysis
  • Disable introspection
• Errors handling
• Events
• Profiler

Talks and slides to help you start

• GraphQL in Symfony by Bernd Alter - Twitter
  • Talk about GraphQL and its implementation with Symfony (26.04.2017) English
• GraphQL is right in front of us, let's do it! by Renato Mendes Figueiredo - Twitter, GitHub
  • Slides at http://talks.mefi.in/graphql-scotphp17 English
  • Video at SymfonyCamp UA 2017 English
  • Video at DPC 2017 English
• A GraphQL API: From hype to production by Aurélien David - Twitter, GitHub
  • Slides at https://cap-collectif.slides.com/spyl/web2day-2019 English
• Une API GraphQL: du hype à la prod by Aurélien David - Twitter, GitHub
  • Video at PHPTour 2017 Nantes French
• Introduction to Symfony Flex and setting up OverblogGraphQLBundle with it by Renato Mendes Figueiredo - Twitter, GitHub
  • Slides at http://talks.mefi.in/symfony-flex-101-symfonycampua English
  • Video at Symfony Camp UA 2017 English

Community

• Get support on Symfony devs Slack on the dedicated channel overblog-graphql.
• Get support in Telegram group Overblog GraphQL
• Follow us on GitHub

Contributing

• See contributing documentation
• Thanks to all contributors