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

pdfloresjdav/api-doc-bundle

pdfloresjdav/api-doc-bundle is a Symfony bundle that turns PHP API metadata into readable documentation, helping teams publish endpoint references, schemas, and request/response details with minimal setup. It fits into existing Symfony projects and aims to make API docs easier to generate and mainta...

View on GitHub
Deep Wiki
Context7

NelmioApiDocBundle for symfony 2.8 and swagger 2

Frequently asked questions about Api Doc Bundle
Can I use pdfloresjdav/api-doc-bundle in a Laravel application?
No. This package is a Symfony bundle: it ships a bundle class, DependencyInjection extensions, Symfony routing and event integration, and expects YAML config under config/packages. Laravel has no concept of bundles, so nothing here maps to a service provider, a config/*.php file, or an Artisan command. Making it work in Laravel would require a custom adapter layer that does not exist. Treat it as a no-go for Laravel and pick a Laravel-native documentation tool instead.
Is this package the same as nelmio/api-doc-bundle?
It is a personal fork of NelmioApiDocBundle targeting Symfony 2.8 and Swagger 2. There is no published changelog or diff against upstream, so you cannot reason about its behavior from upstream documentation. It is also only a single fork with no stars, dependents, or release tags, whereas upstream is actively maintained with OpenAPI 3 and PHP 8 attribute support. If you are on Symfony, depend on the upstream package rather than this artifact.
How do I install pdfloresjdav/api-doc-bundle?
In a Symfony project you would require it via Composer, register the bundle in your kernel or bundles.php, import its routing file, and add configuration under config/packages. Because there is no versioning discipline or release tagging, you would likely need to add it as a VCS repository pinned to a specific commit SHA. There is no Laravel installation path at all, since there is no service provider or auto-discovery support.
Which PHP and Symfony versions does this bundle support?
The package description explicitly targets Symfony 2.8 with Swagger 2 output, which implies an old PHP range and an end-of-life framework line. Annotation parsing relies on doctrine/annotations, so the practical PHP ceiling is well below modern 8.x attribute-first tooling. There is no documented compatibility matrix, so you would have to validate PHP version, framework major, symfony/routing, and doctrine/annotations presence yourself. That is a lot of unverified surface area for a dependency.
Does it generate Swagger 2 or OpenAPI 3 documentation?
Based on the package description it emits Swagger 2, not OpenAPI 3. Upstream Nelmio has already moved to OpenAPI 3 and PHP 8 attributes in v4 and later, so this fork is pinned to a legacy spec format. If your consumers or gateway tooling expect OpenAPI 3, this fork will not produce it without significant patching. Confirm the emitted spec version before committing to it.
What should I use instead for Laravel API documentation?
The idiomatic choices are knuckleswtf/scribe for doc generation from routes and annotations, dedoc/scramble for zero-annotation OpenAPI generated straight from your code, and darkaonline/l5-swagger if your team is committed to Swagger-PHP annotations. All three are Laravel packages with service providers, publishable config, and Artisan commands. Run a short bake-off between Scribe and Scramble on one representative controller group before deciding. None of them require a Symfony bundle or a fork.
Can I install this fork alongside nelmio/api-doc-bundle?
No, that is unsafe. The fork almost certainly reuses the Nelmio\ApiDocBundle namespace, which means class collisions and unpredictable autoload behavior if both are installed. Composer may not even resolve the conflict cleanly if the package names differ but the namespaces overlap. Pick exactly one: upstream Nelmio, or the fork, never both.
Is this fork maintained and safe to use in production?
There is no evidence of release tagging, CI, security advisory coverage, or maintainer responsiveness, and the repository shows zero stars and zero dependents. Security scanning will likely flag it as an unknown-source or abandoned dependency, and there is no CVE patch stream behind it. If you must use it short-term, pin it to a commit SHA via a VCS repository entry, record it in your SBOM, and set an explicit exit date. Also verify the upstream LICENSE and NOTICE files were preserved before any commercial use.
Does annotation scanning slow down my application?
Documentation generation in this approach is reflection-heavy because it parses annotations and docblocks through doctrine/annotations. Runtime correctness and performance depend on cache warmup and a properly configured cache warmer in Symfony. If the cache warmer is misconfigured you will pay parsing cost on requests, which is a common source of unexpected latency. This is another reason to prefer attribute-based or code-driven generators on modern stacks.
How do I migrate off this fork to a supported solution?
First confirm whether the target application is Symfony or Laravel, since that determines whether this package is even relevant. On Symfony, diff the fork against the matching upstream nelmio/api-doc-bundle tag, upstream any local patch if possible, then depend on the upstream package with a pinned constraint. On Laravel, treat this as a no-go and pilot Scribe or Scramble on one or two controllers. In both cases, complete a license and security review of the fork before making any code changes.
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.
robertmarney/lara-hierarchial-collections
simonschaufi/rule-doc-generator
emissaoja/emissaoja
blackbricksoftware/gravityforms-civicrm-form-processor
al-rahabi/fancy-crud
jinas/dhivatar-component
mltstephane/laravel-quality
bernskiold/laravel-talentlms
bernskioldmedia/laravel-form-architect
youbar/easy-crud
c-point-labs/laravel-hostyourai
dbravoan/dbcms-admin-theme-dbcms
dbravoan/dbcms-theme-db-cyber
dbravoan/dbcms-blocks-basic
dbravoan/dbcms-module-content-audit
dbravoan/dbcms-module-ai-assistant
paygate-to/paygate-php
padosoft/askmydocs-connector-base
defstudio/supercharged-carbon
bernskioldmedia/laravel-matomo