Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/player259/graphql-bundle
Integrates graphql-php library into symfony applications
https://github.com/player259/graphql-bundle
api graphql php symfony symfony-bundle
Last synced: 24 days ago
JSON representation
Integrates graphql-php library into symfony applications
- Host: GitHub
- URL: https://github.com/player259/graphql-bundle
- Owner: player259
- License: mit
- Created: 2020-11-15T06:59:37.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-02T10:13:32.000Z (over 3 years ago)
- Last Synced: 2024-04-21T15:13:28.972Z (7 months ago)
- Topics: api, graphql, php, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 40 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Player259GraphQLBundle
## About
The Player259GraphQLBundle integrates [webonyx/graphql-php](https://github.com/webonyx/graphql-php) library
into symfony applications.
[](https://github.com/player259/graphql-bundle/actions)
[Usage documentation](https://github.com/player259/graphql-bundle/blob/master/Resources/doc/index.rst).
## Features
* Types-as-services with Dependency Injection
* Controller-like resolvers with [Autowiring](https://github.com/player259/graphql-bundle/blob/master/Resources/doc/index.rst#autowiring)
* Type definition and resolvers in the same class, see [Basic usage](https://github.com/player259/graphql-bundle/blob/master/Resources/doc/index.rst#basic-usage)
* No extra configuration files
* No static calls
* Native [webonyx/graphql-php](https://github.com/webonyx/graphql-php) type system with all its features and great [documentation](https://webonyx.github.io/graphql-php/)
* Integrated [Type Registry](https://github.com/player259/graphql-bundle/blob/master/Resources/doc/index.rst#type-registry)
* Possible [Code splitting](https://github.com/player259/graphql-bundle/blob/master/Resources/doc/index.rst#code-splitting) for Query and Mutation types
* Simplified [Deferred resolving](https://github.com/player259/graphql-bundle/blob/master/Resources/doc/index.rst#deferred-resolving) with integrated buffer
## Installation
The Player259GraphQLBundle requires PHP 7.1+ and Symfony 4.4+.
You can install the bundle using [Symfony Flex](https://symfony.com/doc/current/setup/flex.html):
$ composer require player259/graphql-bundle
If you're not using Flex, then add the bundle to your `config/bundles.php`:
```php
// config/bundles.php
return [
// ...
Player259\GraphQLBundle\Player259GraphQLBundle::class => ['all' => true],
];
```
Import routing file:
```yaml
# in app/config/routes.yaml
player259_graphql:
resource: '@Player259GraphQLBundle/Resources/config/routing.xml'
prefix: /
```
Or assign endpoint to specific url:
```yaml
# in app/config/routes.yaml
player259_graphql_index:
path: /graphql
controller: Player259\GraphQLBundle\Controller\GraphQLController
```
By default bundle registers `/graphql` endpoint.
## Configuration
Default configuration in `config/packages/player259_graphql.yaml`.
```yaml
# in app/config/packages/player259_graphql.yml
player259_graphql:
debug: '%kernel.debug%'
logger: '?logger'
```
With `debug` option set to `true` response errors will contain `debugMessage` and `trace`.
`logger` parameter is a service name to log exceptions.
If it's prefixed with `?` it will not throw exception if no such service exists.
## Example
To create your first GraphQL API (with default Symfony 5 installation and no configuration):
1. Create class which extends webonyx `ObjectType` with name `Query`
2. Add at least one field and resolver
3. Make a request to `/graphql` url
```php
'Query',
'fields' => [
'username' => [
'type' => Type::string(),
'description' => 'Current User username',
],
],
];
parent::__construct($config);
}
public function resolveUsername(Security $security): ?string
{
return $security->getUser() ? $security->getUser()->getUsername() : null;
}
}
```
## Documentation
Usage examples can be found in [documentation](https://github.com/player259/graphql-bundle/blob/master/Resources/doc/index.rst).
## Not yet implemented
Pass execution rules, disabling introspection, query depth and complexity.
Dispatching events to override server parameters such as promiseAdapter, error formatters and handlers.
Allow to merge non-root types to get more flexibility.
Maybe custom type config property `resolveMethod` to call specific method or another service.
Another option is annotations, something like `@GraphQL\Resolve("App\GraphQL\QueryType", "users")`
so it could be attached to any service with public method.
There will be no autowiring but it can be useful in some cases.
## License
Released under the MIT License, see LICENSE.