This is a beta release of documentation for Magento 2.4, published for previewing soon-to-be-released functionality. Content in this version is subject to change. Links to the v2.4 code base may not properly resolve until the code is officially released.

Debugging GraphQL queries

Edit on GitHub
Log an Issue

This topic provides recommendations on how to debug GraphQL requests.

Debugging with PHPStorm and Xdebug

When using GraphiQL or any other client for testing GraphQL queries, you might need to debug the request processing. You can use Xdebug for debugging the PHP execution of a GraphQL query just as you would for other HTTP requests. To start debugging, add the ?XDEBUG_SESSION_START=PHPSTORM parameter to the endpoint URL. The following example shows how to establish a connection between Xdebug and PHPStorm IDE.

1

http://<magento2-3-server>/graphql?XDEBUG_SESSION_START=PHPSTORM

You can also enable an Xdebug connection for a particular request by setting the corresponding header parameter.

1

Cookie: XDEBUG_SESSION=PHPSTORM

As a result, Xdebug within the PHP execution attempts to make a connection to an IDE. If the IDE is listening, it will give the instructions to Xdebug about breakpoints and other relevant information.

Thanks to Atwix for contributing this topic
© 2020 Magento. All rights reserved.