SwagGraphQL

A simple plugin that exposes an GraphQL-API for the Shopware Platform Core-API.

Installation

Clone this repo in your custom/plugins folder of your Shopware Platform Template.

run:

cd custom/plugins/SwagGraphQL
composer install
cd ../../..
bin/console plugin:install SwagGraphQL
bin/console plugin:activate SwagGraphQL

After installing the plugin the GraphQL endpoint is available under {baseUrl}/api/graphql.

Getting started

Getting started with GraphQL.

The easiest way to fiddle around with the Shopware GraphQL-API is to use GraphiQL, for example as a Chrome-Extension

Custom Fields

You can define your custom fields, by implementing the GraphQLField Interface and tagging your Field either with the swag_graphql.queries or swag_graphql.mutations tag. In either case you have to specify the name under which the field will be queryable inside the service tag, either as mutation or query

Example

in services.xml:

<service id="SwagGraphQL\Actions\GenerateUserKeyAction">
    <tag name="swag_graphql.queries" query="generate_user_key"></tag>
</service>

your class:

class GenerateUserKeyAction implements GraphQLField
{
    public function returnType(): Type
    {
        return new ObjectType([
            'name' => 'UserAccessKey',
            'fields' => [
                'accessKey' => [
                    'type' => Type::nonNull(Type::id())
                ],
                'secretAccessKey' => [
                    'type' => Type::nonNull(Type::id())
                ]
            ]
        ]);
    }

    public function defineArgs(): array
    {
        return [];
    }

    public function description(): string
    {
        return 'Generates the access keys for a user.';
    }

    public function resolve($rootValue, $args, Context $context, ResolveInfo $info)
    {
        return [
            'accessKey' => AccessKeyHelper::generateAccessKey('user'),
            'secretAccessKey' => AccessKeyHelper::generateSecretAccessKey(),
        ];
    }
}

Connection Informations

{
    plugins {
        total
        pageInfo {
            endCursor
            hasNextPage
            startCursor
            hasPreviousPage
        }
        aggregations {
            name
        }
        edges {
            node {
                name
                active
            }
        }
    }
}

Example queries

Query generate integration key

query {
    generateIntegrationKey {
        accessKey
        secretAccessKey
    }
}

Query sort product

query {
    products(
        sortBy: "id"
        query: { type: equals, field: "manufacturer.name", value: "Renner LLC" }
    ) {
        edges {
            node {
                id
                name
            }
        }
        total
    }
}

Query aggregation product

query {
    products(
        aggregations: [
            { type: avg, field: "active", name: "active_avg" }
            { type: count, field: "active", name: "active_count" }
            { type: max, field: "active", name: "active_max" }
            { type: min, field: "active", name: "active_min" }
            { type: stats, field: "active", name: "active_stats" }
            { type: sum, field: "active", name: "active_sum" }
        ]
    ) {
        total
        aggregations {
            name
            buckets {
                keys {
                    field
                    value
                }
                results {
                    type
                    result
                }
            }
        }
    }
}

Mutation delete product

mutation {
    deleteProduct(id: "003395c2d85f46bcaa4439ac2a93c7df")
}

Mutation update product

mutation {
    updateProduct(id: "003395c2d85f46bcaa4439ac2a93c7df", name: "new product") {
        id
        name
    }
}

Dependencies

It uses webonyx/graphql-php for the GraphQL part, doctrine/inflector for string manipulation and the Shopware 6 Framework-Bundle for schema generation and query resolving.

The Tests also depend on the Shopware 6 Content-Bundle.

Known Problems

Nested connections don't really work.