Skip to content

Commit d282713

Browse files
authored
Merge pull request #884 from cakephp/4.x-use-with-api-only-app
Add doc section to explain how to use toolbar with an api only project
2 parents cd05c7b + 35d8593 commit d282713

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

docs/en/index.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,20 @@ to include the panel::
291291
The above would load all the default panels as well as the ``AppPanel``, and
292292
``MyCustomPanel`` panel from ``MyPlugin``.
293293

294+
Accessing Toolbar without a frontend
295+
====================================
296+
297+
If you have an application which only provides an API (and therefore no frontend)
298+
the usual way of accessing the toolbar can't be used.
299+
300+
Instead you have to call http://localhost/debug-kit/toolbar/``<debugkit-id>``
301+
302+
The ``<debugkit-id>`` can be found inside the HTTP headers of your API response. It should look something like that::
303+
304+
X-DEBUGKIT-ID: 5ef39604-ad5d-4ca4-85d8-8595e52373bb
305+
306+
So you would have to call http://localhost/debug-kit/toolbar/5ef39604-ad5d-4ca4-85d8-8595e52373bb
307+
294308
Helper Functions
295309
================
296310

0 commit comments

Comments
 (0)