- Can I use nayzo/api-doc-bundle in a Laravel application?
- No. Despite being described as a Laravel/PHP package, nayzo/api-doc-bundle is a Symfony bundle and an enhanced fork of nelmio/api-doc-bundle, so it depends on Symfony's dependency injection container and bundle registration rather than Laravel service providers and routing. It cannot be dropped into a Laravel app without a full port. For Laravel, use Scramble, Scribe or L5-Swagger instead.
- How do I install nayzo/api-doc-bundle?
- Install it with Composer inside a Symfony application, then register the bundle in config/bundles.php and import its configuration and routing. Because the bundle decorates Nelmio internals, nelmio/api-doc-bundle must also be installed and configured alongside it. Confirm the exact requirements in the repository's composer.json before wiring it into a build pipeline.
- What does nayzo/api-doc-bundle add over nelmio/api-doc-bundle?
- It is an explicit enhanced version of NelmioApiDocBundle aimed at producing more readable documentation: better layout, endpoint grouping and clearer authentication notes. The improvements are presentational rather than a new generation engine, and some may already be native in Nelmio v4 and later. Benchmark it against current upstream before adopting the fork.
- Which Symfony, PHP and Nelmio versions does nayzo/api-doc-bundle support?
- There is no published support matrix; the constraints live only in composer.json. Because the bundle decorates Nelmio internals, compatibility is tied to a specific Nelmio major or minor line, not just a Symfony version. Pin exact versions and treat PHP 8 attribute support as a hard gate, since an annotation-only fork is a dead end on PHP 8.4 and Symfony 7.
- Is nayzo/api-doc-bundle actively maintained?
- Public signals are weak: roughly three GitHub stars, no dependents and no meaningful issue volume. There is no downstream validation, which means no community bug discovery and no established CVE response path. Check the last commit date, release tags and CI status before relying on it, and treat a vendored snapshot as unmaintained rather than a maintained fork.
- What should Laravel teams use instead for API documentation?
- For attribute-driven OpenAPI 3 without annotations, Scramble introspects routes and form requests automatically. For annotation authoring plus a Swagger UI, darkaonline/l5-swagger has the largest community surface. For human-readable internal or partner-facing docs with Postman and OpenAPI export, Scribe is a strong fit. For externally consumed APIs, a hand-authored openapi.yaml with CI linting is often the safest contract-first option.
- Can an upstream Nelmio release break this bundle's build?
- Yes, and that is the main technical risk. Because the bundle decorates Nelmio internals, a routine upstream patch can break Symfony DI container compilation, which fails hard at build time, typically in CI where documentation generation runs. Pin exact versions, assume no semver guarantee across Nelmio minors, and add a review gate before it touches any pipeline.
- How do I migrate off nayzo/api-doc-bundle to nelmio/api-doc-bundle v4?
- Migrate toward upstream, not away from it: replace the fork with current nelmio/api-doc-bundle and zircote/swagger-php attributes. The mechanical work is converting docblock annotations into PHP 8 attributes across every controller, and effort scales linearly with endpoint count. Sample five controllers first, then extrapolate your estimate from real timings.
- Does nayzo/api-doc-bundle generate OpenAPI 3 or Swagger documentation?
- It inherits its generation model from nelmio/api-doc-bundle, which historically produced documentation from docblock annotations, while current Nelmio versions moved to swagger-php attributes and a v4 architecture. An annotation-driven fork is architecturally behind that line and diverges further with each upstream release. Verify which specification version your pinned Nelmio line emits before promising OpenAPI 3 output to consumers.
- Is nayzo/api-doc-bundle safe to add to a production build?
- Treat it as high risk: single-organisation maintenance, low visibility and zero dependents mean no community-vetted edge cases, so you would be the QA team. It also carries attribution obligations inherited from the upstream fork, which is MIT licensed. Run an internal review of the license, composer constraints and last commit date before adding it to any build or deployment pipeline.