Api Kit Laravel Package

Product Decisions This Supports

• Standardization of API responses: Enables consistent JSON payloads across all endpoints, reducing frontend integration friction and improving developer experience.
• Accelerated API development: Abstracts boilerplate exception handling and response formatting, allowing teams to focus on business logic.
• Enforced validation: DTO validation (including #[MapRequestPayload], #[MapQueryString], and #[MapUploadedFile]) ensures data integrity at the API layer, reducing bugs early.
• Scalable error handling: Centralized ApiException and automatic exception conversion to JSON responses improves debugging and client error handling.
• File upload support: Simplifies handling of complex multipart requests (images, videos) with built-in validation and error handling.
• Build vs. buy decision: Justifies buying this package over custom solutions for teams already using Symfony, reducing maintenance overhead.
• Roadmap alignment: Supports future-proofing APIs with modern PHP/Symfony features (PHP 8.2+, Symfony 7.4+) and minimal dependencies.
• Use cases:
  • Rapid prototyping of REST APIs.
  • Standardizing APIs across microservices.
  • Enforcing validation and error handling in greenfield or legacy Symfony projects.

When to Consider This Package

• Adopt if:

  • Your team uses Symfony 7.4+ and PHP 8.2+.
  • You need consistent API responses without manual JSON formatting.
  • You want automatic exception handling to reduce boilerplate in controllers.
  • Your API requires DTO validation (request payloads, query strings, or file uploads).
  • You prioritize minimalist, opinionated solutions over flexible but complex frameworks (e.g., API Platform).
  • Your architecture is Symfony-centric (e.g., layered or traditional MVC).

• Look elsewhere if:

  • You’re not using Symfony (this is a Symfony Bundle).
  • You need GraphQL support (this is REST-only).
  • Your team prefers maximal flexibility over standardized responses (e.g., custom JSON schemas per endpoint).
  • You require advanced API features like OpenAPI/Swagger auto-generation (consider API Platform or NelmioApiDoc).
  • Your project uses older PHP/Symfony versions (not compatible with <8.2/<7.4).
  • You need real-time APIs (WebSockets, SSE) alongside REST.

How to Pitch It (Stakeholders)

For Executives:

"This package standardizes our API responses and error handling, reducing development time by 30%+ while improving consistency. It’s a lightweight, battle-tested solution for Symfony projects—think of it as ‘React Router for APIs.’ By adopting it, we’ll cut bugs from invalid requests and speed up onboarding for new devs. The MIT license and minimal dependencies mean no vendor lock-in, and it aligns with our PHP/Symfony roadmap."

For Engineering:

*"ApiKit gives us:

• No more manual JSON responses: Every endpoint auto-formats to a standardized schema.
• Zero-boilerplate exceptions: Throw ApiException anywhere, and it converts to JSON—no try/catch in controllers.
• Validation out of the box: DTOs handle request payloads, query strings, and file uploads with built-in errors.
• Symfony-native: Works seamlessly with modern Symfony (7.4+) and PHP (8.2+).
• Minimal overhead: Just 1 bundle, no heavy frameworks. Perfect for teams that want consistency without complexity."*

For Developers:

*"Tired of writing the same JSON response wrapper for every endpoint? ApiKit handles it for you. Key perks:

• #[MapRequestPayload]: Validate incoming data like magic.
• #[MapUploadedFile]: Handle file uploads with validation errors automatically.
• AbstractApiController: Shortcuts for JsonResponse with standardized structure.
• No more try/catch hell: Exceptions become JSON responses effortlessly.
• Works with your existing services/repositories: It’s just a thin layer over HTTP."*