Api Bundle Laravel Package

Product Decisions This Supports

• API-First Architecture: Accelerates development of RESTful APIs by providing pre-built, modular components (e.g., resource controllers, serialization, validation) for EkynaResourceBundle, reducing boilerplate and aligning with API-first roadmaps.
• Consistency Across Microservices: Standardizes API structures (routing, responses, error handling) for teams building multiple services, ensuring uniformity in endpoints, payloads, and documentation.
• Build vs. Buy: Avoids reinventing API infrastructure (e.g., DTOs, filters, pagination) when EkynaResourceBundle is already adopted, lowering technical debt.
• Use Cases:
  • Rapid prototyping of CRUD APIs for internal tools or public-facing services.
  • Integrating with frontend frameworks (React, Vue) via standardized JSON responses.
  • Enabling headless CMS or SaaS platforms where API consistency is critical.
  • Extending existing Symfony/Laravel apps with API capabilities without migrating to a full API framework (e.g., API Platform).

When to Consider This Package

• Avoid if:
  • Your team requires GraphQL or WebSocket support (this is REST-only).
  • You need advanced API security (e.g., OAuth2, JWT) out-of-the-box (basic auth may suffice).
  • The project already uses API Platform or Symfony’s MercureBundle for real-time features.
  • You’re building a high-scale API (this bundle lacks built-in caching, rate-limiting, or async processing).
  • Your stack doesn’t include EkynaResourceBundle (dependency lock-in risk).
• Look elsewhere if:
  • You need automatic API documentation (Swagger/OpenAPI) without manual configuration.
  • Your API requires custom domain models beyond Symfony’s ORM (e.g., MongoDB, Elasticsearch).
  • You prioritize developer experience over minimalism (e.g., need interactive API testing tools).
  • The bundle’s maturity (0 stars, minimal adoption) conflicts with your risk tolerance.

How to Pitch It (Stakeholders)

For Executives: "This bundle lets us ship REST APIs 30–50% faster by reusing EkynaResourceBundle’s infrastructure—reducing dev time on boilerplate (controllers, serialization, validation) while keeping costs low (MIT license). Ideal for internal tools, partner integrations, or MVP APIs where speed matters more than customization. Think of it as ‘Symfony’s API starter kit’—no need for a heavy framework like API Platform if we’re already using EkynaResourceBundle."

For Engineering: *"EkynaApiBundle gives us:

• Pre-built resource controllers (no more writing getOne, getCollection from scratch).
• Consistent JSON responses (auto-serialization via EkynaResourceBundle’s hydrators).
• Flexible routing (/api prefix, customizable per environment).
• Lightweight (~500 LOC vs. full API frameworks). Tradeoff: Limited to REST; if we hit scaling walls, we can layer on tools like NelmioApiDoc or Symfony’s Messenger later. Perfect for CRUD-heavy APIs or when we need to iterate fast."*

For Developers: *"If you’re tired of rewriting the same API endpoints, this bundle handles: ✅ Pagination (built into resource controllers). ✅ Filtering (via EkynaResourceBundle’s criteria). ✅ Validation (Symfony Validator integration). ✅ Error responses (standardized formats). Just configure bundles.php and ekyna_api.yaml, and you’re done. No more copy-pasting AbstractController."