interweberde/cakephp-graphql

GraphQL plugin for CakePHP

dev-master 2023-11-21 16:00 UTC

Requires

• beberlei/porpaginas: ^v2.0
• cakephp/authentication: ^2.9.0
• cakephp/authorization: ^2.2.0
• cakephp/cakephp: ^4.0
• php-di/php-di: ^7.0.2
• thecodingmachine/graphqlite: ^v6.2.2

Requires (Dev)

• cakephp/cakephp-codesniffer: ^4.5.1
• interweberde/interweber-cs: ^2.0
• jetbrains/phpstorm-attributes: ^1.0
• phpunit/phpunit: ^9.5.20
• sirbrillig/phpcs-variable-analysis: ^2.8
• squizlabs/php_codesniffer: ^3.7
• vimeo/psalm: ^5.12.0

MIT

• Daniel Melchior

• api
• cakephp
• graphql

README

This Plugin allows you to provide a GraphQL-Endpoint from your CakePHP-App. Be aware though, that some effort is required to get your stuff working.

Project Status

This Package was presented by @xyng at CakeFest 2022 and published shortly after. Documentation is currently not available but we'll work on it! While we do use an earlier version of this package in production, you should currently take on this as being unstable.

Maintenance

We currently cannot guarantee maintenance for this plugin. If you'd like to help us out voluntarily, please reach out via email!

Dependencies

Currently, this plugin depends on the following plugins:

• cakephp/authentication for injecting user and limiting api-access to authenticated users.
• cakephp/authorization to scope mapped queries.

Installation

You can install this plugin into your CakePHP application using composer. The recommended way to install composer packages is:

composer require interweberde/cakephp-graphql

Example App

An Example CakePHP App using this Plugin can be found here: https://github.com/interweberde/cakephp-graphql-example. That Repository contains the exact Backend that was shown in the CakeFest-Talk. The Slides for the CakeFest-Talk are available here: https://damn-daniel.de/files/cakefest-2022-slides.pdf

Testing

Tests are run in a Test App located under TestApp/. To run tests successfully, run composer install in that directory. You can then run tests from the root directory of this repository with composer run test.

Security

We ask you to report security issues as a responsible disclosure via email to [e-mail].