Weave Code
Rest Laravel Package
ibexa/rest
Adds a REST remote API to Ibexa DXP and Ibexa Open Source, letting applications manage content, users, and repositories over HTTP. Useful for building integrations, headless frontends, and third-party clients against Ibexa.
At a glance
Frequently asked questions about Rest
- Is ibexa/rest a Laravel package?
- No. ibexa/rest is a Symfony bundle that adds a REST remote API to an existing Ibexa DXP or Ibexa Open Source installation, so it is not installed into a Laravel application. If you are evaluating Composer packages for Laravel, this package is only relevant when your Laravel app is acting as an HTTP client against a separate Ibexa platform.
- How do I install ibexa/rest?
- Install it with Composer inside a host Ibexa application, then register the bundle in that application. There is no separate greenfield service to deploy; the bundle exposes controllers, parsers, output visitors, and an authentication firewall for /api/ibexa/v2/*. Pin the package to the same Ibexa version line as the rest of your ibexa/* packages.
- Which Ibexa and PHP versions does ibexa/rest support?
- The 4.6 and 5.0 lines are maintained in parallel and are not interchangeable. The 5.x line requires PHP 8.3 and tracks Symfony 7.4 LTS, so your host platform's PHP and Symfony baseline is the real constraint. Choose the version line that matches your Ibexa DXP subscription and support horizon.
- What authentication does the Ibexa REST API support?
- The bundle uses a dedicated Symfony authenticator-based firewall for the REST routes. Token-based authentication is a first-class service in 5.0, and session routes are also available. Decide early whether your clients need stateless token auth only or session semantics.
- What license does ibexa/rest use?
- It is dual-licensed under the Ibexa Business Use License, which requires an active Ibexa DXP subscription, and GPLv2. The GPLv2 branch carries copyleft obligations that matter for any distributed product. Get legal review before shipping code that includes this package; the NOASSERTION SPDX result reflects the dual-license ambiguity.
- Can I use ibexa/rest to build a headless frontend?
- Yes, when the consuming frontend or integration is non-PHP and needs synchronous CRUD, trash, and version workflows over HTTP. For read-optimised delivery, GraphQL or direct PHP API access may fit better. Treat the bundle as the HTTP contract layer over the Ibexa Content Repository, not as a general integration library.
- Is ibexa/rest production-ready and how should I test it?
- It is production-capable inside a supported Ibexa installation, but the API contract changes and framework coupling require regression testing. Verify response shapes, media-type negotiation, authentication flows, and output visitors in automated tests rather than discovering payload issues in production. Budget for re-testing on Symfony patch upgrades, not just major Ibexa upgrades.
- What are alternatives to ibexa/rest?
- For PHP consumers inside the platform, the direct PHP API is usually simpler. For read-heavy delivery to frontends, Ibexa GraphQL can be a better fit than REST. Choose ibexa/rest when you specifically need an HTTP API for mobile apps, middleware, iPaaS, or partner integrations.
- How stable is the ibexa/rest API contract across upgrades?
- The 5.0 changelog includes OpenAPI-alignment work for publish, move, copy, swap, and trash endpoints, plus renamed routes, dropped class_alias BC layers, and deprecated parsers. Legacy and OpenAPI-compatible response shapes coexist, so clients are effectively pinned to a specific minor. Re-verify routes and media types at every upgrade and decide who owns the API contract.
- Does ibexa/rest have community support and ongoing maintenance?
- Independent adoption signals are near zero because this is a split-out repository from a commercial monorepo, not a community-driven project. Support comes from Ibexa through commercial channels rather than a broad ecosystem of contributors. Plan for vendor support and internal ownership instead of relying on community answers.
Weaver
How can I help you explore Laravel packages today?