Weave Code
Api Platform Profiler Bundle Laravel Package
mapado/api-platform-profiler-bundle
A Symfony bundle that adds an API Platform profiler panel to the web debug toolbar, helping you inspect requests, responses, and resource metadata during development.
A profiler extension for api-platform server
Frequently asked questions about Api Platform Profiler Bundle
- What does mapado/api-platform-profiler-bundle actually do?
- It is a Symfony bundle that adds an API Platform panel to the web debug toolbar so you can inspect requests, responses, and resource metadata during development. It hooks into Symfony's WebProfilerBundle through the DataCollectorInterface and DI container tags. It is profiling tooling only and does not change how your API behaves at runtime.
- Does this package work with Laravel?
- No. It is a Symfony bundle built on WebProfilerBundle, the data collector contract, and compiler-pass tag registration, none of which exist in Laravel. Laravel has no equivalent seam to attach this panel to, so architecture fit with a Laravel stack is effectively zero. For Laravel APIs, profile with Telescope and laravel-debugbar instead.
- How do I install it on a Symfony project?
- Install it as a dev dependency with composer require --dev mapado/api-platform-profiler-bundle and enable the bundle in your dev and test environments only. Because the repository is archived with no release cadence, run composer why-not mapado/api-platform-profiler-bundle first to see which PHP, Symfony, or API Platform constraints block resolution. Expect to widen constraints manually, which effectively makes your first commit a fork.
- Which Laravel versions does this package support?
- None. There is no service provider, no config file, and no Laravel integration of any kind, so the question of Laravel 10, 11, or 12 support does not apply. A composer require inside a Laravel app will fail or pull in Symfony and API Platform packages you do not want. Treat any listing that frames this as a Laravel package as inaccurate.
- Is it compatible with API Platform 3?
- That is unproven and unlikely without work. API Platform 3 changed its metadata and data-provider internals substantially, and a profiler that decorates those internals is exactly the kind of package that breaks across that boundary. The bundle is archived with zero stars and zero dependents, so no one is verifying the version matrix. Confirm compatibility on a throwaway app matching your production versions before considering it.
- How should I test it before adopting it?
- Spin up a disposable Symfony plus API Platform application pinned to your production version matrix, add the bundle under require-dev, and confirm the toolbar panel actually renders and collects data. Run composer why-not against your real app to surface stale constraints up front. Only promote it to the real repository after that check passes, and never assume composer require simply resolves.
- Is it safe to ship to production?
- Profiler tooling should never reach production. Keep it in require-dev and build with --no-dev, because a web-accessible profiler panel can leak internal request and response detail. The unmaintained dependency also carries supply-chain exposure. Both risks are manageable but require deliberate dependency hygiene rather than trust in the package.
- Is the package still maintained, and will it survive upgrades?
- No, the repository is archived with no upstream activity, no issue triage, and no release cadence. That means PHP, Symfony, and API Platform upgrades will not be tracked for you, and silent breakage is the expected outcome. If you adopt it, fork it to an internal namespace, pin constraints to your exact versions, and add a re-verification step to your upgrade runbook.
- What should I use instead for profiling Laravel API requests?
- Use Laravel Telescope for request, query, and exception capture, and laravel-debugbar for a per-request timeline. If you need API Platform-style hypermedia insight, a small custom Telescope watcher is a better investment than porting a Symfony bundle. On Symfony, check whether API Platform 3's own tooling or native profiler panels already cover the gap before adding anything.
- Should I fork this bundle or write a custom data collector?
- First name the specific gap you are closing, such as hydra/JSON-LD serialization cost, data-provider query counts, or filter performance. If no gap is named, the tool is not justified. A small custom data collector is typically one to two days of work and gives you ownership, so a fork only makes sense when the existing panel already covers most of what you need.
Weaver
How can I help you explore Laravel packages today?