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

Swagger Ui Bundle Laravel Package

harmbandstra/swagger-ui-bundle

Laravel package that bundles Swagger UI so you can serve interactive OpenAPI/Swagger documentation from your application. It publishes the required assets and provides routes/config to display your API spec with minimal setup.

View on GitHub
Deep Wiki
Context7

Product Decisions This Supports

  • API documentation as a product surface. This release lets you drop a standard Swagger UI config.json into the project and have it applied automatically to the rendered docs. That turns documentation styling, behavior, and defaults (deep linking, request duration display, auth persistence, validator behavior, default models expansion, and similar UI options) into configuration rather than custom code. For a PM, that means API docs polish can be scoped as a config task instead of a frontend engineering ticket.
  • Roadmap sequencing for developer-facing features. If your roadmap includes exposing APIs to partners, building a public developer portal, or onboarding internal consumers, this package is a cheap way to ship interactive, self-serve API docs. The new config.json support lowers the marginal cost of "make the docs feel production-grade," which can pull that work earlier in the roadmap.
  • Build vs. buy for docs tooling. Custom Swagger UI theming or a bespoke docs frontend is now a weaker justification for building. Standard Swagger UI configuration is portable and well-documented upstream, so the package lets you buy the integration and configure the rest.
  • Partner and support cost reduction. Better-configured, interactive docs reduce the volume of "how do I call this endpoint" questions routed to support and solutions engineering. Worth measuring before/after if you enable richer docs for external consumers.
  • Migration and upgrade decisions. Release 4.5.0 is additive and non-breaking from the notes provided — a new optional config file. This is a low-risk upgrade that does not require a compatibility review, version pinning change, or customer communication.

When to Consider This Package

  • Consider it if: you are building or maintaining HTTP/JSON APIs in Laravel and need human-readable, interactive documentation generated from OpenAPI/Swagger annotations or specs; you want docs to live close to the code and deploy with the app; you need customizable docs presentation without forking a UI; or you have external or cross-team API consumers who benefit from a "try it out" experience in staging or internal environments.
  • The 4.5.0 feature is worth adopting when: you have specific UI defaults you want enforced consistently across environments (e.g., collapsed-by-default model views, persisted authorization, filtered tags), or you have been overriding the docs view template purely to change UI options. Switching those to config.json is a net simplification and reduces custom view maintenance.
  • Look elsewhere if: your documentation must be fully decoupled from the application runtime (a separate docs site or portal with its own auth and release cadence), in which case a standalone spec-rendering tool or hosted docs platform is a better fit; or your organization standardizes on a design-first spec pipeline with its own renderer, where a Laravel-embedded UI is redundant.
  • Guardrails before adoption: confirm whether the docs route is exposed in production and how it is protected — public exposure of interactive docs with "try it out" enabled against production is a security and abuse concern. Also confirm that any config.json you ship is environment-appropriate; a single static file applied everywhere is convenient but means you cannot easily vary UI behavior per environment without build-time substitution. Note that this release adds a configuration surface, not authentication, so access control remains your responsibility.

How to Pitch It (Stakeholders)

For executives: This is a small, non-breaking improvement to how our API documentation is presented. It lets us adopt the industry-standard Swagger UI configuration format, so we can make our API docs clearer and more usable through configuration instead of custom development. The business value is faster partner and internal developer onboarding and fewer support requests — at effectively zero engineering cost and no migration risk.

For engineering: Version 4.5.0 adds support for a standard Swagger UI config.json in the project root, automatically applied when rendering the docs. It is additive and opt-in — no changes to existing behavior if you do not add the file. It removes the need to override or fork the docs view template for UI option changes, replacing that with a portable, upstream-documented config format. Recommended actions: upgrade at the next convenient window; audit whether existing view overrides can be replaced by config.json; and verify the docs route's exposure and access controls in production, particularly whether "Try it out" should be enabled outside staging.

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.
htinlynn/genius-helper
maco-studios/hephaestus
elmogy/larafast
xeviant/laravel-paystack
gorilladash/laravel-website-sdk
martialbe/flysystem-oss
chondal/3312client
jeroen-g/flickr
opscale-co/nova-genbi
itsjustvita/laravel-retention
tequilarapido/trackit
gregsphotography/site-builder-filament
cabaoctavio/laravel-query-log
gregsphotography/site-builder-components
io-digital/clickatell
snowsoft/laravel-admin
oxygen/auth
relicsoftware/barakah-payment-gateway
tobya/work-with-composer
equipc/laravel-email-validator