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 Laravel Package

tireconnect/api-doc-bundle

A Symfony bundle for generating API documentation from your application's routes and controllers, exposing a browsable reference and OpenAPI spec with minimal setup. Useful for teams documenting REST APIs directly alongside their code.

View on GitHub
Deep Wiki
Context7

Product Decisions This Supports

  • Public API launch readiness. Documentation generation is a go/no-go gate for any external API: partner onboarding, marketplace/app-store listing, and enterprise procurement reviews all ask "where are the docs?" This capability, not this package, is what unlocks those decisions.
  • Build vs. buy on documentation. The real decision is whether to hand-write and maintain API reference docs (a permanent content-ops cost) or generate them from the code so the contract and the implementation cannot drift. Annotation/introspection-driven generation is the "buy" side of that trade.
  • Support-cost modeling and onboarding funnel. Good generated reference docs move integration questions out of the support queue. This is the strongest ROI argument: measure tickets per integrating partner before and after.
  • Versioning and deprecation policy. If docs are generated from a spec, you can publish v1/v2 side by side, mark endpoints deprecated, and reason about a sunset date without a docs team.
  • SDK/client generation and sandbox strategy. An OpenAPI artifact is the upstream input for Postman collections, client SDKs, and contract tests — a generator is a means to that artifact, not the end.
  • Roadmap sequencing for developer-experience (DevEx) work. Docs are usually bundled with sandbox keys, changelog, and error-code catalog; this package only addresses one slice, so it should be scoped as one workstream, not the whole initiative.

When to Consider This Package

Realistically, this package does not clear the bar for adoption, and the criteria below are written to make that explicit:

  • Only if you are on Symfony, not Laravel. The description says Laravel/PHP, but this is a rebranded NelmioApiDocBundle fork — a Symfony bundle built around Symfony's DI container, routing, and annotation reader. It will not drop into a Laravel app; wiring it means carrying Symfony components alongside Laravel's container.
  • Only if you are pinned to a 2019-era stack. Last release July 2019, on the pre-OpenAPI-3 annotation model that upstream Nelmio has since replaced with zircote/swagger-php and attributes. This fork is frozen several major versions behind.
  • Only if you own the fork. Zero stars, zero dependents means no community, no CVE triage, no upstream merges. Effectively you are the maintainer; treat it as vendored internal code with a named owner, not a dependency.
  • Only if nothing else fits and the API surface is already annotation-annotated and stable.

Look elsewhere when any of the following is true — i.e., almost always:

  • Laravel, PHP 8+, actively developed API: use dedoc/scramble (zero-annotation, reads routes, form requests, and API resources — the closest match to Laravel idioms), knuckleswtf/scribe (human-readable docs plus Postman/OpenAPI export), or darkaonline/l5-swagger if you want a strict OpenAPI-first contract.
  • You want OpenAPI 3 as the source of truth: adopt a spec-first workflow and generate servers/clients/docs from the spec rather than reverse-engineering docs from annotations.
  • Any team without spare capacity to babysit a dead dependency. Security scanning and platform upgrades (PHP 8.x minor bumps, framework majors) will surface this package as an unpatched blocker.
  • You need vendor or procurement sign-off on third-party code provenance — a 0-star fork with no release in six years fails basic supply-chain review.

Verdict: decline. The capability is required; this artifact is a liability. Recommend a one-week spike comparing Scramble, Scribe, and l5-swagger, and standardise on whichever produces an OpenAPI artifact your CI can validate.

How to Pitch It (Stakeholders)

To executives: "Our partner APIs need a published reference to close integrations, cut onboarding support load, and pass enterprise procurement. That capability is on the roadmap and cheap to deliver. I am not recommending the package that surfaced in our evaluation — it is an abandoned 2019 fork of a Symfony library with no maintainers, no users, and no security updates; adopting it would create a permanent upgrade tax we would pay alone. I am recommending we fund the same outcome with a Laravel-native tool and make a generated OpenAPI spec a release gate. Success looks like: docs published per release, integrating partner time-to-first-call down, and support tickets per integrator down."

To engineering: "The underlying idea — derive docs from code so they can't rot — is right. This implementation is wrong for us: it's a Symfony bundle wearing a Laravel label, frozen at a pre-OpenAPI-3 annotation model, with zero adoption and its last release in July 2019. We'd be the sole maintainer and it would show up as a blocker on every PHP and framework upgrade. Counter-proposal: dedoc/scramble for zero-annotation generation off our existing routes and API Resources, emitting OpenAPI 3 we can also use for Postman collections and contract tests. Ask: one week to prototype it against two of our existing endpoints, then a recommendation on build-vs-standardise."

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.
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
pnscripts/filament-broadquill-lite
pnscripts/laravel-sentfold-lite
vleap/mx-sdk-laravel-internal
twidpay/utils
htetmyathlaing/scout-elasticsearch-driver
artisan-toolbox/front-awesome
ls/client-assistant
users-au/laravel-client
cgv/localized-resource