Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/graphpql/graphpinator-nette
:zap::globe_with_meridians::zap: Graphpinator adapters and addons for Nette framework.
https://github.com/graphpql/graphpinator-nette
graphql graphql-php nette php
Last synced: 23 days ago
JSON representation
:zap::globe_with_meridians::zap: Graphpinator adapters and addons for Nette framework.
- Host: GitHub
- URL: https://github.com/graphpql/graphpinator-nette
- Owner: graphpql
- License: mit
- Created: 2020-10-17T15:47:54.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-04T10:07:00.000Z (7 months ago)
- Last Synced: 2024-09-30T17:04:03.209Z (about 1 month ago)
- Topics: graphql, graphql-php, nette, php
- Language: PHP
- Homepage: https://github.com/graphpql
- Size: 310 KB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Graphpinator Nette [](https://github.com/infinityloop-dev/graphpinator-nette/actions?query=workflow%3APHP) [](https://codecov.io/gh/infinityloop-dev/graphpinator-nette)
:zap::globe_with_meridians::zap: Graphpinator adapters and addons for Nette framework.
## Introduction
This package includes adapters and tools to easily integrate Graphpinator into a Nette application.
## Installation
Install package using composer
```composer require infinityloop-dev/graphpinator-nette```
## How to use
### ApiPresenter
Simple version of a presenter to execute GraphQL API requests against a given schema. It can be extended to alter its functionality (for example by overriding the `getEnabledModules` function) or it can serve as an inspiration to include the functionality in your own presenters.
Presenter is enabled by creating a route:
```php
$router[] = new Route('/', [
'module' => 'Graphpinator',
'presenter' => 'Api',
]);
```
You also need to register the module with presenters to map to the correct namespace.
```neon
application:
mapping:
Graphpinator: 'Graphpinator\Nette\*Presenter'
```
There needs to be a `Schema` and a `NetteCache` service available in your DI container so that it can be injected into the presenter.
```neon
# Automatically find and register all types and directives located in `GraphQl` namespace as services
search:
graphql:
in: '%appDir%/GraphQL'
extends:
- Graphpinator\Typesystem\Contract\NamedType
- Graphpinator\Typesystem\Contract\Directive
services:
# Register a NetteCache adapter
- Graphpinator\Nette\NetteCache
# The SimpleContainer is a container of GraphQL types
# It is automatically injected by all types and directives as Nette automatically detects a typehint in SimpleContainers contructor
- Graphpinator\SimpleContainer
# Any additional types must be also registred to become available in the type container
- Graphpinator\ExtraTypes\EmailAddressType
- Graphpinator\ExtraTypes\PhoneNumberType
# Register a Schema
- Graphpinator\Typesystem\Schema(
@Graphpinator\SimpleContainer, # Container of types
@App\GraphQL\Query, # Query type
null, # Mutation type
null # Subscription type
)
# Alternativelly you may use the named service and add a setup to the Schema service
schema.public:
factory: Graphpinator\Typesystem\Schema(
@Graphpinator\SimpleContainer,
@App\GraphQL\Query,
@App\GraphQL\Mutation,
null
)
setup:
- setDescription("""
My GraphQL API
""")
```
### SchemaPresenter
Schema presenter contains two actions.
- actionHtml, which renders HTML page
- actionFile, which renders text file - file is sent to browser as an attachment, which tells the browser to show the download prompt
Action can be enabled using Router, here is the example which enables the HTML action on the `/schema.graphql` path.
```php
$router[] = new Route('/schema.graphql',
'module' => 'Graphpinator',
'presenter' => 'Schema',
'action' => 'html',
]);
```
### GraphiQLPresenter
Presenter which include [GraphiQL](https://github.com/graphql/graphiql/tree/main/packages/graphiql#readme), a graphical interface to interact with your schema.
Presenter is enabled by creating a route:
```php
$router[] = new Route('/graphiql',
'module' => 'Graphpinator',
'presenter' => 'GraphiQl',
'action' => 'default',
]);
```
It is also required to pass a location of your API endpoint, to which GraphiQL will connect to.
```neon
services:
- Graphpinator\Nette\GraphiQlPresenter(':Api:Graphql:default')
```
### Cyclic dependendencies
When using abstract types, the cyclic dependencies must be avoided using accessors. Nette makes it easy by automatically providing implementation for a accessor interface using a simple DI condifuration.
```php
interface SlideAccessor
{
public function getSlideSingle() : SlideSingle;
public function getSlideDouble() : SlideDouble;
public function getSlideTriple() : SlideTriple;
}
```
```neon
services:
- SlideAccessor(
slideSingle: @SlideSingle
slideDouble: @SlideDouble
slideTriple: @SlideTriple
)
```
This interface is than injected into the abstract type instead of the concrete types in order to break the dependency cycle.
### Multiple schemas
Some more sophisticated applications may require to host multiple different GraphQL schemas with different purposes.
In order to do this, we need to use a different approach when configuring the DI.
```neon
# Search and register all the types in directives in a given namespace - and also append a tag to those services
search:
graphqlPublicTypes:
in: '%appDir%/GraphQL/Public'
extends:
- Graphpinator\Typesystem\Contract\NamedType
tags:
- graphql.public.types
graphqlPublicDirectives:
in: '%appDir%/GraphQL/Public'
extends:
- Graphpinator\Typesystem\Contract\Directive
tags:
- graphql.public.directives
services:
# Register a container and inject services with a tag
publicContainer:
factory: Graphpinator\SimpleContainer(
tagged( graphql.public.types )
tagged( graphql.public.directives )
)
# Register a Schema using a container with the correct set of types
- App\GraphQL\Public\Schema(@publicContainer)
```
It is reccomended to use a separate class for each `Schema` so that it can be easily registered as a separate service and injected into a presenter.
```php
getType('Query'), $container->getType('Mutation'));
$this->setDescription('My GraphQL API');
}
}
```
### Adapters
- `\Graphpinator\Nette\TracyLogger`
- Implements logger interface for logging in `\Graphpinator\Graphpinator`.
- `\Graphpinator\Nette\NetteRequestFactory`
- Implements `RequestFactory` and enables direct creation of `\Graphpinator\Request\Request` from Nette HTTP abstraction.
- `\Graphpinator\Nette\FileProvider`
- Implements `FileProvider` interface needed by `infinityloop-dev/graphpinator-upload` module.
- `\Graphpinator\Nette\NetteCache`
- Adapter from Nette Caching to Psr CacheInterface needed by `infinityloop-dev/graphpinator-persisted-queries` module.