Skip to content
Magento GraphQL data models and query builders for AEM
Branch: master
Clone or download

README.md

CircleCI Maven Central

Magento GraphQL data models and query builders

This project contains the Magento GraphQL data models and query builders that have been automatically generated based on the Magento GraphQL schema. These classes can be used to build GraphQL requests and to parse/deserialise GraphQL JSON responses into java objects.

Versioning

The following versioning scheme is used for that maven dependency: MAJOR.MINOR.PATCH-magentoXYZ.

The MAJOR.MINOR.PATCH parts refers to the semantic versioning of this maven artifact.

The magentoXYZ part refers to the version of the Magento GraphQL API, for example for Magento GraphQL 2.3.0 or 2.3.1.

For example, the first released version of this artifact is 1.0.0-magento230, which means that it uses the GraphQL schema from Magento 2.3.0 and is the first major version of that artifact.

Using the query builders and parsing responses

To use this library in your project, just add the following maven dependency to your project and install the bundle in your AEM instance:

<dependency>
    <groupId>com.adobe.commerce.cif</groupId>
    <artifactId>magento-graphql</artifactId>
    <version>...</version>
    <scope>provided</scope>
</dependency>

You can check some examples to create GraphQL queries and parse the JSON responses in the unit tests. In addition, you can use our generic GraphQL client bundle for AEM to send the queries.

Releases to Maven Central

Releases are triggered by manually running mvn release:prepare release:clean on the master branch. This automatically pushes a commit with a release git tag like magento-graphql-x.y.z-magento230 which triggers a dedicated CircleCI build that performs the deployment of the artifact to Maven Central.

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.

You can’t perform that action at this time.