Weave Code
Base Rest Bundle Laravel Package
acseo/base-rest-bundle
Symfony bundle providing a base REST layer you can extend to expose your entities. Designed as a starting point for building REST APIs with reusable controllers/services; install via Composer and enable the bundle in your kernel.
A bundle to manage your REST application
Frequently asked questions about Base Rest Bundle
- Can I use ACSEOBaseRestBundle in Laravel projects, or is it strictly for Symfony?
- This bundle is designed for Symfony and relies on its components like Doctrine ORM, EventDispatcher, and Symfony’s routing. For Laravel, you’d need to rewrite core parts (e.g., controllers, routing) or use a Symfony Bridge (like `symfony/http-foundation`). Native Laravel integration isn’t supported out of the box.
- What Laravel alternatives exist for reusable REST controllers?
- For Laravel, consider Laravel API Resources (built-in), Fractal, or packages like `spatie/laravel-api` for structured REST APIs. These are natively compatible and don’t require Symfony dependencies. API Platform (Symfony) is another alternative if you’re open to Symfony.
- How do I install ACSEOBaseRestBundle in a Symfony project?
- Run `composer require acseo/base-rest-bundle:dev-master` and enable the bundle in `AppKernel.php` under `registerBundles()`. Note: This uses `dev-master`, so stability isn’t guaranteed. Check the GitHub repo for updates or fork it for tagged releases.
- Does this bundle support Laravel’s Eloquent ORM, or only Doctrine?
- The bundle assumes Doctrine ORM (common in Symfony). For Laravel, you’d need to adapt it to Eloquent or use Doctrine DBAL as a middle layer. This isn’t documented, so expect manual work to bridge the two.
- Is ACSEOBaseRestBundle production-ready, or should I avoid it?
- This bundle is unmaintained (no updates since 2016) and lacks documentation, tests, or CI/CD. Use it cautiously—only for non-critical APIs or as a learning tool. Forking and adapting it for your stack is recommended.
- How do I customize the REST endpoints generated by this bundle?
- The bundle is designed to be extended. Override its base controllers (e.g., `ACSEOBaseRestController`) and services to modify routing, validation, or serialization. Symfony’s dependency injection allows easy swapping of components.
- Will this bundle work with Laravel’s built-in API features like Sanctum or API Resources?
- No, this bundle conflicts with Laravel’s native features. Sanctum (auth) and API Resources (serialization) rely on Laravel’s service container and middleware, which aren’t compatible with Symfony’s architecture. Rewrite or isolate usage.
- Are there examples or tests to understand how to use this bundle?
- The README mentions ‘TODO: doc,’ and there are no examples, tests, or GitHub issues addressing common use cases. You’ll need to reverse-engineer the bundle’s structure or adapt existing Symfony REST tutorials.
- Can I use this bundle for high-traffic APIs, or is it only for small projects?
- There’s no performance data or optimizations documented. Given its lack of maintenance and testing, it’s risky for production APIs. For high traffic, use battle-tested Laravel packages like `spatie/laravel-api` or Symfony’s API Platform.
- How do I handle validation in this bundle compared to Laravel’s FormRequest?
- The bundle uses Symfony’s Validator component, which won’t integrate directly with Laravel’s FormRequest. You’d need to rewrite validation logic or create a custom bridge between Symfony’s constraints and Laravel’s validation rules.
Weaver
How can I help you explore Laravel packages today?