Introduction

In the following sections we’ll show how to implement queries and mutations for the OXID eShop GraphQL API from scratch, step by step.

To start with your own module, you will definitely need an up and running OXID eShop with the GraphQL base module installed.

Preparations

We don’t want to duplicate work like say setting up a brand new graphql module from scratch. So we already prepared a little something: Skeleton GraphQL OXID module

Let’s try this out:

composer create-project oxid-esales/graphql-module-skeleton

We get prompted for vendor and package name and end up with a ready to use module. Give it a repo, install into OXID eShop via composer, activate. The module skeleton comes with a Category controller as example, so at this point you can use a GraphQL client like Altair to verify you see the category query in the schema.

The Namespace mapper

Let’s assume we want to fetch information for one specific item (let’s take a product) via the OXID eShop GraphQL API, which means we need to implement a new Controller and DataType.

So in our module’s src directory, let’s add the Product directory structure:

├── ..
└── Product
    ├── Controller
    ├── DataType
    ├── Exception
    ├── Infrastructure
    └── Service

Have a look at the Shared/Service/NamespaceMapper.php, this is the place to register controller and type namespaces.

├── ..
    ├── Shared
    │   └── Service
    │       └── NamespaceMapper.php
    ..

<?php

declare(strict_types=1);

namespace MyVendor\GraphQL\MyGraph\Shared\Service;

use OxidEsales\GraphQL\Base\Framework\NamespaceMapperInterface;

final class NamespaceMapper implements NamespaceMapperInterface
{
    public function getControllerNamespaceMapping(): array
    {
        return [
            '\\MyVendor\\GraphQL\\MyGraph\\Category\\Controller' => __DIR__ . '/../../Category/Controller/',
            '\\MyVendor\\GraphQL\\MyGraph\\Product\\Controller' => __DIR__ . '/../../Product/Controller/',
        ];
    }

    public function getTypeNamespaceMapping(): array
    {
        return [
            '\\MyVendor\\GraphQL\\MyGraph\\Category\\DataType' => __DIR__ . '/../../Category/DataType/',
            '\\MyVendor\\GraphQL\\MyGraph\\Product\\DataType' => __DIR__ . '/../../Product/DataType/',
            '\\MyVendor\\GraphQL\\MyGraph\\Product\\Service'   => __DIR__ . '/../../Product/Service/',
        ];
    }
}