Apidoc Bundle Laravel Package

Product Decisions This Supports

• Accelerate API Documentation: Reduce manual effort in maintaining API docs by automating Swagger/OpenAPI v3 generation from YAML, PHP classes, or hybrid approaches.
• Developer Experience (DX): Enable IDE-friendly documentation via attributes (e.g., linking controllers to docs) and CLI tools for schema generation, improving onboarding and maintainability.
• Multi-UI Support: Align with team preferences by offering Swagger UI, Redoc, Stoplight, RapiDoc, or Scalar without vendor lock-in.
• Hybrid Documentation Strategy: Bridge legacy YAML-based docs with modern PHP-based definitions, easing migration for large codebases.
• Build vs. Buy: Avoid reinventing OpenAPI tooling; leverage this bundle to reduce technical debt while maintaining flexibility.
• Roadmap for API-First Development: Support future initiatives like automated API testing (e.g., linking docs to test suites) or AI-driven doc generation.

When to Consider This Package

• Use this package if:

  • Your team uses Symfony and needs OpenAPI v3 documentation with minimal boilerplate.
  • You prioritize flexibility (YAML, PHP classes, or hybrid) over rigid tooling.
  • Your API consumers (internal/external) benefit from multiple UI options (Swagger, Redoc, etc.).
  • You want to reduce documentation drift by tying docs to code (e.g., via attributes).
  • Your roadmap includes CLI-driven workflows (e.g., auto-generating schemas for new endpoints).

• Look elsewhere if:

  • You’re not using Symfony (this is a Symfony-specific bundle).
  • Your team requires enterprise-grade support (low stars/dependents may signal immaturity).
  • You need GraphQL or gRPC docs (this focuses solely on REST/OpenAPI).
  • Your org mandates strict YAML-only or PHP-only workflows (hybrid may add complexity).
  • You lack Symfony Flex or Composer contrib permissions (blockers for installation).

How to Pitch It (Stakeholders)

For Executives: "This bundle cuts API documentation time by 40%+ by auto-generating Swagger/OpenAPI v3 specs from our existing code or YAML files. It supports multiple UI tools (Swagger, Redoc, etc.), ensuring our devs and partners can access docs in their preferred format. With CLI tools for schema generation and IDE integration, we’ll reduce errors and speed up onboarding—all while keeping docs in sync with our API codebase."

For Engineers: "ApiDocBundle lets us define API docs in YAML, PHP classes, or both, with seamless merging. The attributes feature links controllers to docs for easy navigation in IDEs, and CLI commands (e.g., generate:schema) save hours on manual updates. We get Swagger UI, Redoc, and more out of the box—no need to stitch together tools. Perfect for Symfony projects where docs should live alongside code."