- Is citizen63000/easy-api-core compatible with Laravel 10.x, and does it require Symfony 6.4?
- The package is designed for Laravel 10+ with Symfony 6.4+ components, as noted in the release documentation. Always test against your exact Laravel version, as Symfony versioning may introduce compatibility quirks. Check the `composer.json` constraints for precise version requirements.
- Can I use this package for GraphQL APIs, or is it strictly REST-focused?
- The package is REST-first and lacks explicit GraphQL or WebSocket support. While it may coexist with GraphQL tools like `laravel-graphql`, it enforces REST conventions (DTOs, HTTP status codes) and isn’t protocol-agnostic. For hybrid setups, evaluate middleware conflicts carefully.
- Does this package replace Laravel’s built-in API Resources, or should I use both?
- It’s complementary, not a replacement. The package provides DTOs, validation, and serialization utilities that can coexist with Laravel’s API Resources. Use it to standardize responses across your API while retaining Laravel’s flexibility for custom resource logic.
- How does authentication work? Can I integrate with Sanctum or custom JWT providers?
- The package includes pre-configured JWT/OAuth2 support but doesn’t enforce a specific auth system. You can integrate with `laravel/sanctum` or `typhonnetworks/laravel-jwt-auth` by extending its middleware or auth logic. Custom auth flows (e.g., SAML) require manual middleware chaining.
- Will using DTOs from this package add significant performance overhead?
- DTO serialization/deserialization may add 5–20ms per request due to reflection. Profile with tools like Blackfire or Laravel Debugbar to measure impact. For high-traffic APIs, consider caching serialized responses or optimizing DTO structures.
- Can I customize validation rules or middleware without forking the package?
- Yes, the package supports extension via traits and abstract classes. For validation, override the `validate()` method in your DTOs or extend the `CoreUtilsTrait`. Middleware can be dynamically chained per route using Laravel’s middleware stack.
- Does this package support multi-tenancy (e.g., tenant-aware requests) out of the box?
- No, multi-tenancy isn’t natively supported. You’ll need to manually inject tenant context (e.g., `tenant_id` in DTOs or middleware). Pair it with packages like `stancl/tenancy` for full multi-tenancy if required.
- Are there built-in tools for API contract testing (e.g., OpenAPI generation)?
- The package doesn’t include OpenAPI generation, but you can integrate it with tools like `darkaonline/l5-swagger` or `zircote/swagger-php`. Use the DTOs and standardized responses to auto-generate API docs.
- How does this compare to alternatives like Laravel API Resources or Spatie’s Laravel API?
- Unlike `spatie/laravel-api`, this package leans on Symfony components and enforces DTOs for validation/serialization. It’s heavier than Laravel’s native API Resources but offers more utilities (e.g., form serialization, command abstractions). Choose it for modular monoliths needing consistency.
- Is there a test suite or benchmarking data to assess reliability?
- The package lacks a visible test suite or benchmarks in the repository. Mitigate risks by writing integration tests for auth, validation, and error responses. Profile performance with tools like Blackfire to validate assumptions about DTO overhead.