README

GraphQL server in PHP, implemented through the PoP API

Install

Installing the GraphQL server

Follow the instructions in the GraphQL by PoP installation page.

Installing the library in a PoP application

Via Composer

composer require graphql-by-pop/graphql-server

To enable pretty API endpoint /api/graphql/, follow the instructions here

Development

The source code is hosted on the GatoGraphQL monorepo, under GraphQLByPoP/packages/graphql-server.

Usage

Initialize the component:

\PoP\Root\App::stockAndInitializeModuleClasses([([
    \GraphQLByPoP\GraphQLServer\Module::class,
]);

Support for REST

By installing the REST package, the GraphQL server can also satisfy REST endpoints, from a single source of truth.

Demo

The GraphQL API (running on top of a WordPress site) is deployed under this endpoint: https://newapi.getpop.org/api/graphql/

You can play with it through the following clients:

GraphiQL: https://newapi.getpop.org/graphiql/
GraphQL Voyager: https://newapi.getpop.org/graphql-interactive/

PHP versions

Requirements:

PHP 8.1+ for development
PHP 7.4+ for production

Supported PHP features

Check the list of Supported PHP features in GatoGraphQL/GatoGraphQL

Preview downgrade to PHP 7.4

Via Rector (dry-run mode):

composer preview-code-downgrade

Standards

PSR-1, PSR-4 and PSR-12.

To check the coding standards via PHP CodeSniffer, run:

composer check-style

To automatically fix issues, run:

composer fix-style

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

To execute PHPUnit, run:

composer test

Static Analysis

To execute PHPStan, run:

composer analyse

Report issues

To report a bug or request a new feature please do it on the GatoGraphQL monorepo issue tracker.

Contributing

We welcome contributions for this package on the GatoGraphQL monorepo (where the source code for this package is hosted).

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email leo@getpop.org instead of using the issue tracker.

Credits

License

GNU General Public License v2 (or later). Please see License File for more information.

graphql-by-pop / graphql-server

Maintainers

Details