CODEWITHSUNDEEP
restxdebugphpstorm
Daniel Hollands
Daniel Hollands

Reputation: 6681

XDebug and RESTful server using PHPStorm or POSTman

How can I get a REST client (such as the one built into PHPStorm or POSTman) to work with XDebug?

In my current set-up of XDebug, using PHPStorm and the Bookmarklet provided I'm able to get it working in both Chrome and Firefox - but as soon as I try with POSTman or any other REST client, I can't figure out how to get it started.

Cheers.

Upvotes: 112

Views: 129046

Answers (9)

Ali Samie
Ali Samie

Reputation: 470

There is a more dynamic way to do so:

  1. Define a variable in your Postman collection
  2. Implement a Pre-request script in that collection

Step 1: Step 1

Step 2: enter image description here

Here is the pre-request script:

if (pm.collectionVariables.get("IS_XDEBUG_ACTIVE") == "1") {
    pm.request.headers.add({
        key: "Cookie",
        value: "XDEBUG_SESSION"
    });
}

Upvotes: 15

MohamedHarmoush
MohamedHarmoush

Reputation: 1352

Configure PHPStorm XDebug to trigger on RESTful API requests

Please, check this answer => https://stackoverflow.com/a/73802240/13321079

Upvotes: 1

Hassan Ali Shahzad
Hassan Ali Shahzad

Reputation: 2734

you can set xdebug cookie into postman to use it from postman as well. their are one link Cookies under the Send button click on it. and add new cookie. XDEBUG_SESSION = PHPSTORM their and save

Upvotes: 1

LazyOne
LazyOne

Reputation: 165353

You can use one of these approaches:

  1. Configure your Xdebug (by editing php.ini) to attempt to debug every PHP script. The key option:

    • Xdebug v2: xdebug.remote_autostart = 1
    • Xdebug v3: xdebug.start_with_request = yes

  2. Add Xdebug session start parameter to the actual URL (XDEBUG_SESSION_START={{KEY}} -- https://xdebug.org/docs/step_debug#manual-init), for example: ?XDEBUG_SESSION_START=PHPSTORM

  3. Pass Xdebug cookie as part of the request (the one which is set by bookmarklet or browser extension, for example).

For this to work: make sure that "phone handle" icon is activated in advance in PhpStorm (Run | Start Listen for PHP Debug Connection).

P.S. If you are using Postman, Insominia or alike (another REST client) then the best / most transparent way IMO is to use Xdebug cookie. You're most likely already using separate Environments (e.g. "dev", "test", "production") so you can have such a cookie only where it is needed (depends on the tool and version used of course).

This way there is no need to edit the URL (even if you have it as a "conditional parameter" that is present for some environment and absent for another) or configure Xdebug to "debug all requests" at all.

An example of such Xdebug cookie from my Postman (edit it as needed; here it is set for the local some-domain.local.test fake domain):

XDEBUG_SESSION=value; Path=/; Domain=.some-domain.local.test; Expires=Tue, 19 Jan 2038 03:14:07 GMT;

Since the host URL should be a part of your Environment (e.g. the endpoint URL will be like {{host}}/api/v1/welcome) then such cookie will be sent to the dev domain only and not to the production one.

Upvotes: 265

Kevin
Kevin

Reputation: 121

What finally got my Postman/PHPStorm Xdebug working was adding a PHP Remote Debug configuration in PHPStorm:

Run -> Edit Configurations -> + -> PHP Remote Debug

I just set the name to localhost and saved it - no IDE Key, etc.

Upvotes: 0

Aleksandar Stojilkovic
Aleksandar Stojilkovic

Reputation: 497

Just add ?XDEBUG_SESSION_START=filter_string at the end of the url, for eg:

https://new-supplier.local/api/login?XDEBUG_SESSION_START=PHPSTORM

PHPSTORM is my default filter string, you can use whatever you want. Your editor should be set up to filter connections by IDE key (filter string), and thats it. You should be able to debug the same way as from Chrome or FF.

Upvotes: 33

tsanecki
tsanecki

Reputation: 61

Warning!

xdebug >= 3.0 has changed the parameters in php.ini. After upgrading xdebug, most of the answers here will not be relevant.

Refer to: https://xdebug.org/docs/upgrade_guide

Basically, you need to add something like this to your php.ini:

xdebug.mode=develop,gcstats,coverage,profile,debug
xdebug.start_with_request=1
xdebug.idekey=PHPSTORM

Upvotes: 3

Nikunj Acharya
Nikunj Acharya

Reputation: 797

xdebug.remote_timeout = 60000

Worked for me. As my Mac was very slow, and Remote debugger was timed out after 200 ms (Default value)

Upvotes: 1

RyanNerd
RyanNerd

Reputation: 3189

This was driving me crazy. I just updated to PHP 7.1 and xdebug that was working no longer worked. I updated the xdebug.so file (Linux) and php --version indicated that xdebug was indeed being loaded and working. But when I would use Postman the debugger never kicked on.

Here's the solution. If you are using Apache as your server then you need to enable the PHP 7.1 mods and reboot Apache: sudo service apache2 restart

Upvotes: 2

Related Questions