Weave Code
Weaver
Helps Laravel developers discover, compare, and choose open-source packages. See popularity, security, maintainers, and scores at a glance to make better decisions.
Feedback
Share your thoughts, report bugs, or suggest improvements.
Subject
Message
Api Doc Bundle

Api Doc Bundle Laravel Package

gohiei/api-doc-bundle

gohiei/api-doc-bundle is a PHP package for generating browsable API documentation from your application's routes and annotations. It keeps endpoint references close to the code, making internal or public API docs easier to maintain and share with your team.

View on GitHub
Deep Wiki
Context7

gohiei/api-doc-bundle is a Symfony bundle for adding API documentation to your application with minimal setup. It helps keep endpoint references close to your code and provides a straightforward way to expose browsable API docs for developers and consumers.

  • Symfony-native integration via bundle configuration and services
  • Route/controller-based documentation for application endpoints
  • Customizable output to fit your project’s documentation needs
  • Lightweight setup with minimal configuration required
Frequently asked questions about Api Doc Bundle
Is gohiei/api-doc-bundle a Laravel package?
No. It is a Symfony bundle and a fork of nelmio/NelmioApiDocBundle, so it relies on Symfony bundles, dependency injection compiler passes, and HttpKernel listeners. It contains no Laravel service provider, facade, config file, or extra.laravel.providers entry, so Laravel package discovery will not register it.
Can I install gohiei/api-doc-bundle with Composer in a Laravel app?
Composer may resolve the package, but installing it does not make it usable in Laravel. Nothing will boot because there is no Laravel service provider, and the documentation generator expects Symfony routing and controller conventions. Making it work would require a custom integration layer that you own.
Does gohiei/api-doc-bundle support Laravel 9, 10, or 11?
No. The last release was in December 2019, which places it in the Symfony 3 and 4 and PHP 7.1 to 7.4 era, well before modern Laravel versions and PHP 8 attributes. There is no indication of support for Laravel 8 or later, and no maintained compatibility path.
What Laravel API documentation package should I use instead?
For Laravel, use dedoc/scramble for zero-annotation reflection-based docs, knuckleswtf/scribe for generated human-readable documentation, or darkaonline/l5-swagger if you need Swagger UI with annotations. An OpenAPI-first workflow with a checked-in spec is also a solid option and removes runtime annotation dependencies.
Why is gohiei/api-doc-bundle incompatible with Laravel routing?
The bundle reads annotations from Symfony controllers and reflects over Symfony's RouteCollection to produce an OpenAPI-style document. Laravel uses Illuminate\Routing\Route, its own controller resolution, and a different middleware pipeline. Bridging the two would mean writing a route adapter and controller reflector, which is most of the package's core work.
Is gohiei/api-doc-bundle safe for production?
Treat it as a supply-chain risk. The repository has zero stars and no visible adoption, the fork provenance is unclear, and there is no security patch path for issues in doctrine/annotations, symfony components, or zircote/swagger-php. For a documentation tool, that is not a risk worth taking.
How does gohiei/api-doc-bundle differ from nelmio/api-doc-bundle?
It is a fork of NelmioApiDocBundle from the v3 era, published under a personal account, and the metadata does not explain what changed. If you are on Symfony, use the maintained upstream nelmio/api-doc-bundle v4 or v5 instead. This fork adds nothing for Laravel and is stale for Symfony.
How do I install gohiei/api-doc-bundle in Symfony?
In a Symfony 3 or 4 project you would require the package with Composer, enable the bundle in config/bundles.php or AppKernel, and configure nelmio_api_doc settings. However, because the package is abandoned and forked, you should use upstream nelmio/api-doc-bundle instead. Verify PHP and Symfony version constraints before attempting anything.
Does gohiei/api-doc-bundle support PHP 8 attributes or OpenAPI 3?
No. It predates PHP 8 attributes and the Nelmio v4 attribute-based generation model, so it works with the older annotation approach. If you need PHP 8 attributes or modern OpenAPI 3 output, look at maintained upstream Nelmio or a Laravel-native alternative.
How much work is it to integrate gohiei/api-doc-bundle with Laravel?
Realistically it is days to weeks of bespoke engineering. You would need a service provider that boots a Symfony DI container, an adapter from Illuminate\Routing\Route to Symfony Route objects, a Laravel-compatible controller reflector, and middleware to replace Symfony kernel listeners for the UI and JSON endpoints. You would also own that integration layer indefinitely with no upstream support.
Weaver

How can I help you explore Laravel packages today?

Conversation history is not saved when not logged in.
Prompt
Add packages to context
No packages found.
shitoudev/permissionmanager
johannesclimacus/laravel-tui
hocvt/seotools
vitalybaev/sypexgeo
amphibee/themosis-ignition
gito-me/fast-excel
frankyso/laravel-ipaymu
geolize-studio/laravel-chile
boomerangui/chat
jinas/dhivatar
store-doc/laravel-storage-driver
plus-it/laravel-translation-manager
diephp/perhaps
diephp/telegraph
osmaviation/spreadsheet
microsoft/fluentui-system-icons
mmccook/php-json-canonicalization-scheme
middlewares/firewall
qubiqx/montapacking
nyoncode/laravel-package-console