Weave Code
Api Laravel Package
laravie/api
A Laravel package for structuring JSON APIs with a lightweight, organized approach to endpoints and responses. Laravie API helps keep API code clean and consistent inside Laravel applications, making backend services easier to build and maintain.
🔨 An alternative RESTful API package for the Laravel and Lumen frameworks.
Frequently asked questions about Api
- What is laravie/api used for in Laravel?
- Laravie API is a thin controller-layer helper that gives Laravel applications convention-based API routing, flexible resource transformation for Eloquent models, and consistent JSON response handling. It is aimed at developers who want organized, boilerplate-free endpoints without adopting a full API framework. It is not an all-in-one solution: versioning, validation, authentication, pagination, and domain error modeling are outside its scope.
- How do I install and configure laravie/api?
- Installation is Composer-based, like any Laravel-native package, and the code footprint is small. Configuration is intentionally minimal with sensible defaults, so most projects will only need to register routes and define resource transformations. Because published documentation is sparse, verify the exact config keys and service provider registration against the repository's README and source before wiring it into an existing app.
- Which Laravel and PHP versions does laravie/api support?
- Version 5.0.0 of laravie/api adds Laravel 9 support, which is the most recent framework version explicitly claimed by the package. It is unclear whether Laravel 9 is a floor or the only target, and PHP version constraints are not documented in the changelog. Check the composer.json constraints in the tagged release and pin an exact version rather than assuming broad compatibility.
- Does laravie/api support Laravel 10, 11, or 12?
- There is currently no claim or published evidence of Laravel 10, 11, or 12 support. Laravel 9 is itself past security end-of-life, so the package should not be assumed fit for newer applications without verification. Run a compatibility spike against your actual Laravel version matrix before committing to it in a new service.
- What breaks between laravie/api 4.x and 5.x?
- The 4.x to 5.x upgrade is documented in a single line, and no upgrade notes, deprecation list, or migration guidance were published. A major version bump for a one-line changelog strongly implies dropped framework support or other breaking behavior, but the specifics are unverified. Diff the two releases in a disposable Laravel 9 service to enumerate the actual changes before upgrading an existing integration.
- How does laravie/api format JSON responses and errors?
- The package emphasizes consistent JSON response handling, giving you a uniform envelope for success and error payloads inside Laravel controllers. The exact response envelope and HTTP status conventions it enforces are not clearly documented, so confirm them from source. Its interaction with Laravel's global exception handler, including validation responses and 404 rendering, is also unverified and should be tested explicitly.
- Is laravie/api a good alternative to Laravel API Resources?
- Laravel's built-in JsonResponse, API Resources, and a small internal response trait achieve similar consistency with fewer dependencies. Laravie API's advantage is convention-based routing plus transformation in one small, permissively licensed package. For most teams, the native approach is the lower-risk default, with laravie/api considered when you specifically want its routing conventions.
- Does laravie/api handle validation errors, authentication failures, and pagination?
- These concerns are not addressed by the package's core scope, which centers on routing conventions, resource transformation, and JSON response formatting. How 404s, auth failures, validation errors, and paginated collections are rendered depends on Laravel itself and on whether the package hooks into global exception rendering. Test each of these paths in a pilot before relying on the package for public API contracts.
- Is laravie/api actively maintained and safe for production?
- Adoption signals are low, with roughly 14 stars on GitHub, and a long gap between releases was only recently interrupted by v5.0.0. The release confirms a named maintainer and permissive BSD-3-Clause licensing, which is a positive sign of life but not proof of ongoing maintenance. There is no stated security policy, CI evidence, or roadmap, so treat it as reference-only or a constrained pilot rather than an organization-wide standard.
- How should I test laravie/api and keep an exit path if it is abandoned?
- Wrap the package behind an internal ApiResponse abstraction or adapter so your controllers depend on your own contract rather than package helpers. Pin an exact version, then run a spike that covers the response envelope, exception handling, validation errors, auth failures, and pagination against your real Laravel version. This adapter approach also insulates you from undocumented breaking changes like the 4.x to 5.x bump, making a later switch back to native Laravel responses straightforward.
Weaver
How can I help you explore Laravel packages today?