noma-solutions/api-doc-bundle
A Symfony bundle that turns your API endpoints into clear, browsable documentation. Generates docs from routes and controllers, supports customization, and helps keep reference docs in sync with your code.
Consider evaluating it only when:
nelmio/NelmioApiDocBundle — for example, to assess whether a fork carries a patch you need.Look elsewhere when:
dedoc/scramble (zero-annotation, infers OpenAPI from code and validation rules) or knuckleswtf/scribe (human-readable docs plus Postman/OpenAPI output). Either gives you a maintained, Laravel-native path with actual community validation.nelmio/NelmioApiDocBundle directly — it has the maintainers, the issue tracker, and the security response path.Adoption criteria checklist (any candidate): maintained release cadence, ≥1 active maintainer with a response history, dependents in the hundreds or thousands, compatible license (MIT here — fine), documented upgrade path across major framework versions, and a CI story for spec drift.
For executives — one paragraph. A documentation generator turns annotated code into a live OpenAPI specification. It is leverage, not a product feature: it shortens partner integration cycles, reduces support load, and makes API deprecations safe to ship. The category is worth a small investment. This specific package is not the vehicle — it is a zero-star fork of a Symfony bundle with no dependents and no maintenance signal, which means adopting it creates a dependency we cannot audit or get patched. Recommendation: fund a short evaluation of maintained, Laravel-native alternatives instead; cost is roughly one engineer-week, license cost is zero (MIT), and the downside of the wrong choice is a documentation layer that silently rots.
For engineering — the ask. Run a two-day spike comparing dedoc/scramble and knuckleswtf/scribe against our current docs process on one representative service. Decision criteria: (1) zero manual annotation drift — docs must be generated from code and validation rules, not maintained by hand; (2) emitted spec validates as OpenAPI 3.x and is consumable by our gateway and client generators; (3) a CI check fails the build when the spec changes unexpectedly; (4) upgrade path survives the next framework major. If the spike is clean, adopt and template it for new services.
For finance/procurement. No license cost. Total cost of ownership is maintenance attention, which is why maintainer health — not feature lists — is the deciding factor here. The candidate under review fails that test at 0 stars and 0 dependents.
How can I help you explore Laravel packages today?