getpop / api-graphql
Extended/Upgraded implementation of GraphQL, implemented on PHP, based on the PoP API
Requires
- php: ^8.1
- pop-api/api-mirrorquery: ^8.0
Requires (Dev)
- phpstan/phpstan: ^1.8
- phpunit/phpunit: ^10.2
- rector/rector: ^0.18
- squizlabs/php_codesniffer: ^3.6
Conflicts
- gatographql-standalone/gatographql: <8.0.0
- gatographql/external-dependency-wrappers: <8.0.0
- gatographql/gatographql: <8.0.0
- gatographql/plugin-utils: <8.0.0
- gatographql/testing-schema: <8.0.0
- getpop/access-control: <8.0.0
- getpop/cache-control: <8.0.0
- getpop/component-model: <8.0.0
- getpop/componentrouting: <8.0.0
- getpop/definitions: <8.0.0
- getpop/dom-crawler: <8.0.0
- getpop/engine: <8.0.0
- getpop/engine-wp: <8.0.0
- getpop/engine-wp-bootloader: <8.0.0
- getpop/filestore: <8.0.0
- getpop/graphql-parser: <8.0.0
- getpop/guzzle-http: <8.0.0
- getpop/loosecontracts: <8.0.0
- getpop/mandatory-directives-by-configuration: <8.0.0
- getpop/markdown-convertor: <8.0.0
- getpop/root: <8.0.0
- getpop/root-wp: <8.0.0
- graphql-by-pop/graphiql: <8.0.0
- graphql-by-pop/graphql-clients-for-wp: <8.0.0
- graphql-by-pop/graphql-endpoint-for-wp: <8.0.0
- graphql-by-pop/graphql-request: <8.0.0
- graphql-by-pop/graphql-server: <8.0.0
- graphql-by-pop/graphql-voyager: <8.0.0
- phpunit-for-gatographql/dummy-schema: <8.0.0
- phpunit-for-gatographql/dummy-wp-schema: <8.0.0
- phpunit-for-gatographql/gatographql: <8.0.0
- phpunit-for-gatographql/gatographql-testing: <8.0.0
- phpunit-for-gatographql/webserver-requests: <8.0.0
- phpunit-for-gatographql/wpfaker-schema: <8.0.0
- pop-api/api: <8.0.0
- pop-api/api-clients: <8.0.0
- pop-api/api-endpoints: <8.0.0
- pop-api/api-endpoints-for-wp: <8.0.0
- pop-api/api-rest: <8.0.0
- pop-backbone/php-hooks: <8.0.0
- pop-backbone/wp-data-parser: <8.0.0
- pop-cms-schema/categories: <8.0.0
- pop-cms-schema/categories-wp: <8.0.0
- pop-cms-schema/category-mutations: <8.0.0
- pop-cms-schema/category-mutations-wp: <8.0.0
- pop-cms-schema/comment-mutations: <8.0.0
- pop-cms-schema/comment-mutations-wp: <8.0.0
- pop-cms-schema/commentmeta: <8.0.0
- pop-cms-schema/commentmeta-wp: <8.0.0
- pop-cms-schema/comments: <8.0.0
- pop-cms-schema/comments-wp: <8.0.0
- pop-cms-schema/custompost-categories-wp: <8.0.0
- pop-cms-schema/custompost-category-mutations: <8.0.0
- pop-cms-schema/custompost-category-mutations-wp: <8.0.0
- pop-cms-schema/custompost-mutations: <8.0.0
- pop-cms-schema/custompost-mutations-wp: <8.0.0
- pop-cms-schema/custompost-tag-mutations: <8.0.0
- pop-cms-schema/custompost-tag-mutations-wp: <8.0.0
- pop-cms-schema/custompost-tags-wp: <8.0.0
- pop-cms-schema/custompost-user-mutations: <8.0.0
- pop-cms-schema/custompost-user-mutations-wp: <8.0.0
- pop-cms-schema/custompostmedia: <8.0.0
- pop-cms-schema/custompostmedia-mutations: <8.0.0
- pop-cms-schema/custompostmedia-mutations-wp: <8.0.0
- pop-cms-schema/custompostmedia-wp: <8.0.0
- pop-cms-schema/custompostmeta: <8.0.0
- pop-cms-schema/custompostmeta-wp: <8.0.0
- pop-cms-schema/customposts: <8.0.0
- pop-cms-schema/customposts-wp: <8.0.0
- pop-cms-schema/media: <8.0.0
- pop-cms-schema/media-mutations: <8.0.0
- pop-cms-schema/media-mutations-wp: <8.0.0
- pop-cms-schema/media-wp: <8.0.0
- pop-cms-schema/menus: <8.0.0
- pop-cms-schema/menus-wp: <8.0.0
- pop-cms-schema/meta: <8.0.0
- pop-cms-schema/metaquery-wp: <8.0.0
- pop-cms-schema/page-mutations: <8.0.0
- pop-cms-schema/page-mutations-wp: <8.0.0
- pop-cms-schema/pagemedia-mutations: <8.0.0
- pop-cms-schema/pages: <8.0.0
- pop-cms-schema/pages-wp: <8.0.0
- pop-cms-schema/post-categories: <8.0.0
- pop-cms-schema/post-categories-wp: <8.0.0
- pop-cms-schema/post-category-mutations: <8.0.0
- pop-cms-schema/post-mutations: <8.0.0
- pop-cms-schema/post-tag-mutations: <8.0.0
- pop-cms-schema/post-tags: <8.0.0
- pop-cms-schema/post-tags-wp: <8.0.0
- pop-cms-schema/postmedia-mutations: <8.0.0
- pop-cms-schema/posts: <8.0.0
- pop-cms-schema/posts-wp: <8.0.0
- pop-cms-schema/queriedobject: <8.0.0
- pop-cms-schema/queriedobject-wp: <8.0.0
- pop-cms-schema/schema-commons: <8.0.0
- pop-cms-schema/schema-commons-wp: <8.0.0
- pop-cms-schema/settings: <8.0.0
- pop-cms-schema/settings-wp: <8.0.0
- pop-cms-schema/tag-mutations: <8.0.0
- pop-cms-schema/tag-mutations-wp: <8.0.0
- pop-cms-schema/tags: <8.0.0
- pop-cms-schema/tags-wp: <8.0.0
- pop-cms-schema/taxonomies: <8.0.0
- pop-cms-schema/taxonomies-wp: <8.0.0
- pop-cms-schema/taxonomy-mutations: <8.0.0
- pop-cms-schema/taxonomy-mutations-wp: <8.0.0
- pop-cms-schema/taxonomymeta: <8.0.0
- pop-cms-schema/taxonomymeta-wp: <8.0.0
- pop-cms-schema/taxonomyquery: <8.0.0
- pop-cms-schema/taxonomyquery-wp: <8.0.0
- pop-cms-schema/user-avatars: <8.0.0
- pop-cms-schema/user-avatars-wp: <8.0.0
- pop-cms-schema/user-roles: <8.0.0
- pop-cms-schema/user-roles-wp: <8.0.0
- pop-cms-schema/user-state: <8.0.0
- pop-cms-schema/user-state-mutations: <8.0.0
- pop-cms-schema/user-state-mutations-wp: <8.0.0
- pop-cms-schema/user-state-wp: <8.0.0
- pop-cms-schema/usermeta: <8.0.0
- pop-cms-schema/usermeta-wp: <8.0.0
- pop-cms-schema/users: <8.0.0
- pop-cms-schema/users-wp: <8.0.0
- pop-schema/directive-commons: <8.0.0
- pop-schema/extended-schema-commons: <8.0.0
- pop-schema/http-requests: <8.0.0
- pop-schema/schema-commons: <8.0.0
- pop-wp-schema/block-content-parser: <8.0.0
- pop-wp-schema/blocks: <8.0.0
- pop-wp-schema/commentmeta: <8.0.0
- pop-wp-schema/comments: <8.0.0
- pop-wp-schema/custompostmeta: <8.0.0
- pop-wp-schema/customposts: <8.0.0
- pop-wp-schema/media: <8.0.0
- pop-wp-schema/menus: <8.0.0
- pop-wp-schema/meta: <8.0.0
- pop-wp-schema/multisite: <8.0.0
- pop-wp-schema/pages: <8.0.0
- pop-wp-schema/posts: <8.0.0
- pop-wp-schema/schema-commons: <8.0.0
- pop-wp-schema/settings: <8.0.0
- pop-wp-schema/site: <8.0.0
- pop-wp-schema/taxonomymeta: <8.0.0
- pop-wp-schema/usermeta: <8.0.0
- pop-wp-schema/users: <8.0.0
- dev-master / 8.1.x-dev
- 8.0.0
- 7.0.8
- 7.0.7
- 7.0.6
- 7.0.5
- 7.0.4
- 7.0.3
- 7.0.2
- 7.0.1
- 7.0.0
- 6.0.2
- 6.0.1
- 6.0.0
- 5.0.0
- 4.2.0
- 4.1.1
- 4.1.0
- 4.0.1
- 4.0.0
- 3.0.0
- 2.6.1
- 2.6.0
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.3
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.1
- 2.0.0
- 1.6.0
- 1.5.5
- 1.5.4
- 1.5.3
- 1.5.2
- 1.5.1
- 1.5.0
- 1.4.0
- 1.3.1
- 1.3.0
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.15
- 1.0.14
- 1.0.13
- 1.0.12
- 1.0.11
- 1.0.10
- 1.0.9
- 1.0.8
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- 0.10.2
- 0.10.1
- 0.10.0
- 0.9.10
- 0.9.9
- 0.9.8
- 0.9.7
- 0.9.6
- 0.9.5
- 0.9.4
- 0.9.3
- 0.9.2
- 0.9.1
- 0.9.0
- 0.8.9
- 0.8.8
- 0.8.7
- 0.8.6
- 0.8.5
- 0.8.4
- v0.8.3
- v0.8.2
- 0.8.1
- 0.7.13
- 0.7.12
- 0.7.11
- 0.7.10
- 0.7.9
- 0.7.8
- 0.7.7
- 0.7.6
This package is auto-updated.
Last update: 2024-11-30 01:26:31 UTC
README
Extended/Upgraded implementation of GraphQL. This implementation is a package to be installed on top of the PoP API.
Install
Via Composer
composer require pop-api/api-graphql
Development
The source code is hosted on the GatoGraphQL monorepo, under API/packages/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).
Usage
Initialize the component:
\PoP\Root\App::stockAndInitializeModuleClasses([([ \PoPAPI\GraphQLAPI\Module::class, ]);
Features
Automatic namespacing of types
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:
Field/directive-based versioning
Fields and directives can be independently versioned, and the version to use can be specified in the query through the field/directive argument versionConstraint
.
To select the version for the field/directive, we use the same semver version constraints employed by Composer.
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
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.