Home

Overview

Welcome to the Magento 2 GraphQL Community Project!

Here is our ZenHub board, best viewed with the Chrome ZenHub extension. Otherwise, our backlog is organized as a list of issues.

For the last few months, the internal team has been hard at work on the initial implementation for GraphQL in Magento. GraphQL is a flexible and performant API for building custom front-end experiences, including headless storefronts and PWAs. To learn more about GraphQL, please visit graphql.org. To get a head start on the GraphQL implementation in Magento, our DevDocs are here.

To join the project, attend a regular meeting or join #graphql slack channel.

Status

Here is our CURRENT ROADMAP. Roughly speaking, our status is the following:

Completed items:

• Products
• Categories
• Customer
• URL resolution for products, categories, CMS pages

Future items:

• Mutations to support checkout, payments, shipping, My Account, etc
• Increased coverage for entities like products and categories
• Increased coverage for experiences like Checkout and My Account
• Improvements in GraphQL framework
• Performance related improvements

Contact Information

Status meetings: Every Thursday at 15:00 UTC, https://magento.zoom.us/j/760857552

Slack channel: #graphql. Send an email to engcom@magento.com to join

Approach to Implementation

See Approach to Implementation for the requirements and restrictions of the implementation process.

Issues Board

See Issues Board on ZenHub for the list of issues.

Pipelines:

• New Issues - newly created items, which have not been discussed yet
• Icebox - candidates for backlog items. Do not take items from this pipeline
• Investigation - being investigated by someone to clarify requirements or implementation details
• Backlog - ready for development
• In Progress - in progress by someone
• Review/QA - in review or QA by Magento team
• Merging in Progress - the PR is in being processed by Magento team to be merged to target branch. ❕ The pipeline may also contain items that wait for a related PR in another repository (can be an internal repository and so not visible for community)
• Closed - closed issues

Feel free to add an issue to the list of issues if you know of any. These will be reviewed by the core team to confirm before being taken to work.

Labels

• backward-incompatible - the fix/implementation might be backward incompatible. Must be resolved before Magento 2.3 release
• blocker - the issue blocks resolution of other issue(s). For example, the issue causes a fatal error, which terminates execution of the application and so blocks validation/fixing of other scenarios
• investigation-needed - an investigation is needed. A clear solution is not known yet, the issue can't be taken into development
• additional-coverage - issues which focus on coverage of some functionality with GraphQL API
• framework-changes - issues which assume modifications to the GraphQL framework
• requires-ee-changes - requires changes in Magento EE being merged together with the CE fix. Example: update of composer.json in CE requires same changes being applied to composer.json in Magento EE
• requires-b2b-changes - requires changes in Magento B2B being merged together with the CE fix. Example: update of composer.json in CE requires same changes being applied to composer.json in Magento B2B

Git Repository

There are the following branches in the repository:

• 2.3-develop - target branch for all contributions

Development Environment

You can set up Magento locally, use docker or virtual machine. For those who are just starting, take a look at vagrant box for Magento 2 developers

Documentation

All completed GraphQL features are documented on the dev docs

Useful links

• Optimizing storefronts with GraphQL in Magento 2
• Magento Web API Technical Vision

Meeting links

Magento EngCom Hangout