Extended/Upgraded implementation of GraphQL, implemented on PHP, based on the PoP API
Extended/Upgraded implementation of GraphQL. This implementation is a package to be installed on top of the PoP API.
composer require getpop/api-graphql
To enable pretty API endpoint
/api/graphql/, follow the instructions here
Note: if you wish to install a fully-working API, please follow the instructions under Bootstrap a PoP API for WordPress (even though CMS-agnostic, only the WordPress adapters have been presently implemented).
Initialize the component:
\PoP\Root\AppLoader::addComponentClassesToInitialize([ \PoP\GraphQLAPI\Component::class, ]);
This package adapts all those features to GraphQL.
Namespaces (proposed to be added to the GraphQL spec) help manage the complexity of the schema. This can avoid different types having the same name, which can happen when embedding components from a 3rd party.
This is how the normal schema looks like in the GraphQL Voyager:
This is how it looks in its namespaced version:
Fields and directives can be independently versioned, and the version to use can be specified in the query through the field/directive argument
To select the version for the field/directive, we use the same semver version constraints employed by Composer.
In this query, field
userServiceURLs has 2 versions,
Let's use constraints with
> to select the version. In this query, constraint
"^0.1" is resolved to version
"0.1.0", but constraint
">0.1" is resolved to version
This query demonstrates it for directives:
versionConstraint parameter in the GraphQL endpoint itself will implicitly define that version constraint in all fields, and any field can still override this default value with its own
versionConstraint, as in this query:
- PHP 8.0+ for development
- PHP 7.1+ for production
Check the list of Supported PHP features in
Via Rector (dry-run mode):
To check the coding standards via PHP CodeSniffer, run:
To automatically fix issues, run:
Please see CHANGELOG for more information on what has changed recently.
To execute PHPUnit, run:
To execute PHPStan, run:
To report a bug or request a new feature please do it on the PoP monorepo issue tracker.
We welcome contributions for this package on the PoP monorepo (where the source code for this package is hosted).
If you discover any security related issues, please email firstname.lastname@example.org instead of using the issue tracker.
GNU General Public License v2 (or later). Please see License File for more information.