README.md

GraphQL

This extension integrates GraphQL into TYPO3 CMS. Currently it provides an read API for managed tables. For more information about the planned features see the draft.

This implementation is a proof-of-concept prototype and thus experimental development. Since not all planned features are implemented, this extension should not be used for production sites.

Installation

Use composer to install this extension in your project:

composer config repositories.cms-configuration git https://github.com/typo3-initiatives/configuration
composer config repositories.cms-security git https://github.com/typo3-initiatives/security
composer config repositories.cms-graphql git https://github.com/typo3-initiatives/graphql
composer require typo3/cms-graphql

Usage

The entity reader provides an easy access to the managed tables of TYPO3 CMS:

use TYPO3\CMS\GraphQL;

$reader = new EntityReader();
$result = $reader->execute('
    tt_content {
        uid,
        header,
        bodytext
    }
');

For more examples checkout the functional tests.

Development

Development for this extension is happening as part of the TYPO3 persistence initiative.