- Can I use pbaszak/extended-api-doc-bundle in a Laravel application?
- No. Despite being catalogued as a Laravel/PHP package, this is a Symfony bundle that decorates nelmio/api-doc-bundle, which does not exist in Laravel. Laravel's OpenAPI tooling such as Scribe, Scramble, and Dedoc uses entirely different rendering and extension points, so no configuration will bridge the two. Only evaluate this if your stack is Symfony with NelmioApiDocBundle already installed.
- How do I install extended-api-doc-bundle?
- Install it with composer require --dev pbaszak/extended-api-doc-bundle and register it in config/bundles.php, ideally only for the dev and test environments. You must already have nelmio/api-doc-bundle installed and configured. After registering, confirm that the bundle's template and asset overrides take precedence over Nelmio's own Swagger UI templates, and pin both packages in composer.json.
- What does this bundle actually change in my API documentation?
- It overrides NelmioApiDocBundle's Swagger UI templates and assets to change how endpoints are grouped and sorted by tag. It also applies minor CSS and styling corrections to the original Nelmio view. There is no service-layer logic, no runtime request path involvement, and no database or queue surface, so it sits purely in the documentation-generation layer.
- Which versions of nelmio/api-doc-bundle are supported?
- There is no published compatibility matrix, and the last release (February 2024) predates the current Nelmio 5.x line. Because the package patches view and template behavior rather than extending a stable public API, every Nelmio release that touches Swagger UI templates or asset publishing is a potential break. Run composer why nelmio/api-doc-bundle and verify constraints before committing to it.
- Is the tag sorting behavior configurable?
- There is no documented configuration for a custom comparator or an explicit tag ordering list, so the sorting behavior appears hardcoded in the template override. If you need specific tag ordering or a custom sort, plan to modify the templates yourself. Diffing the package against your pinned Nelmio version will show exactly what the sort logic looks like and how easy it is to adjust.
- Is this package safe to use in production?
- It is a dev-only, documentation-layer tool that should not affect runtime requests, but you should still constrain it to require-dev and register the bundle only in dev and test environments. The broader risk is project health rather than code complexity: zero stars, zero dependents, a single release, a single maintainer, and no visible CI or test coverage. Pin it and Nelmio together to limit surprise upgrades.
- How actively maintained is extended-api-doc-bundle?
- Adoption signals are essentially absent: no stars, no dependents, one release, and one maintainer, with no stated governance or contribution path. There is no evidence of CI, test coverage, or a support channel. Treat it as a reference implementation rather than a dependency you rely on long term, and check whether the maintainer accepts pull requests or has a handoff plan.
- How large is the actual change, and can I vendor it instead?
- The change is likely a small diff consisting of template sorting logic plus some CSS, so vendoring is realistic. Diff the package's templates and assets against your pinned Nelmio version to quantify it, then copy the result into your application's templates/bundles/NelmioApiDocBundle/ override directory with a comment linking upstream and recording the MIT attribution. That removes the dependency, any version-constraint conflict, and the supply-chain surface while preserving the behavior.
- What are the alternatives for better Swagger UI in Symfony?
- Use nelmio/api-doc-bundle directly and override its Swagger UI templates and assets in your own application, or add a small custom CSS and JS file to adjust ordering and styling. If you only need tag-based grouping, check what Nelmio's configuration already exposes before adding another package. For Laravel projects, look at Scribe, Scramble, or Dedoc instead.
- Will it break when I upgrade nelmio/api-doc-bundle?
- Quite possibly, because it patches templates rather than extending a stable public API. Any Nelmio release that changes Swagger UI templates or asset publishing can silently break the overrides. Pin both packages, re-diff the templates on each Nelmio upgrade, and keep the vendored copy under review so your API docs keep rendering correctly.