Weave Code
Api Documentation Bundle Laravel Package
fusonic/api-documentation-bundle
A Symfony bundle by Fusonic that generates API documentation directly from your application's routes and controllers, helping teams keep reference docs in sync with the codebase and expose them to developers with minimal configuration.
At a glance
Frequently asked questions about Api Documentation Bundle
- Is fusonic/api-documentation-bundle compatible with Laravel?
- No. It is a Symfony bundle registered through config/bundles.php and relies on Symfony's compiled DI container, routing, and event dispatcher, while Laravel uses service providers and a different container lifecycle. There is no supported shim, so it should not be adopted in a Laravel codebase. Treat it only as a design reference or as tooling for a Symfony service in your estate.
- Can I install fusonic/api-documentation-bundle in a Laravel app via Composer?
- Composer may resolve the package, but it is a thin layer over NelmioApiDocBundle, which is Symfony-only and historically coupled to API Platform and Swagger-PHP. Transitive incompatibility with Laravel is guaranteed rather than incidental. Integration would require a fork-and-rewrite that costs more than building OpenAPI generation from scratch.
- What Laravel version does fusonic/api-documentation-bundle support?
- It does not declare Laravel support at all; it targets Symfony applications. Laravel version compatibility is therefore not applicable. Even the supported Symfony and NelmioApiDocBundle versions are not verifiable from the package metadata alone and would need a short spike.
- What is the best Laravel alternative to fusonic/api-documentation-bundle for API docs?
- For Laravel, use a generator plus renderer split rather than a Symfony bundle. dedoc/scramble is the recommended default because it derives OpenAPI 3.1 from routes, FormRequests, and API resources without annotations, while knuckleswtf/scribe and l5-swagger cover other documentation styles. These first-party Laravel options solve the same problem with supported integration.
- How do I configure fusonic/api-documentation-bundle for a Laravel project?
- There is no Laravel configuration path for this package. Configuration is handled as a Symfony bundle, so Laravel's config files and service providers do not apply. The practical answer is to use a Laravel-native documentation package instead of trying to wire this bundle into Laravel.
- Does fusonic/api-documentation-bundle work with NelmioApiDocBundle?
- It is effectively a wrapper around NelmioApiDocBundle and depends on that Symfony-only package. It can only work where the host Symfony service is already on a NelmioApiDocBundle version this bundle supports, which needs verification in a spike. NelmioApiDocBundle has a history of breaking changes across majors, so a low-traffic wrapper is likely to lag.
- Is fusonic/api-documentation-bundle safe for production use?
- Documentation routes and bundled UI assets must be explicitly gated to non-production or authenticated access, or a misconfiguration can expose internal endpoint surface. The package also has near-zero adoption, so pulling it in for cosmetic documentation gains is a poor supply-chain risk trade. It is not recommended for a Laravel production application.
- How is fusonic/api-documentation-bundle maintained and how many dependents does it have?
- It is a single-vendor Fusonic convenience wrapper with about 3 stars, 0 dependents, and a composite score of 0.015. Expect no issue triage and no security response, because adoption is negligible. The MIT license permits forking, but forking shifts permanent maintenance onto your team.
- Can I use fusonic/api-documentation-bundle for testing or CI contract testing of my API?
- No. It focuses on generating and rendering documentation from routes and controllers, not on CI contract testing or route-introspection guarantees. The larger API-docs risk is stale specs, and this bundle does nothing to solve documentation drift. Pair any generator with contract tests and spec validation if spec correctness matters.
- What is fusonic/api-documentation-bundle and what problem does it solve?
- It is a Symfony bundle that generates API documentation directly from application routes and controllers and provides standardized, themed OpenAPI rendering with minimal configuration. It solves a Symfony documentation problem, not a Laravel one. In Laravel, that problem is already covered by dedoc/scramble, knuckleswtf/scribe, and l5-swagger.
Weaver
How can I help you explore Laravel packages today?