Add Swagger UI to Your Laravel Application

Last updated on by

Add Swagger UI to Your Laravel Application image

The Laravel Swagger UI package makes it easy to make your project's Swagger (OpenAPI v3 JSON or YAML) file accessible in a Swagger UI right in your Laravel application. All you have to do is drop in the OpenAPI file at resources/swagger/openapi.json (configurable) and navigate to /swagger locally in the project:

Swagger UI Petstore Example in a Laravel project
Swagger UI Petstore Example in a Laravel project

What I love about this package is that it automatically updates the Swagger UI to use current project's environment, including setting the API's base URL to the Laravel project's base URL. The package also allows you to configure OAuth2, which can be injected in Swagger UI via the package's configuration file.

The /swagger URL is accessible locally, and you can also define custom gate logic to authorize and provide access control to the Swagger UI in non-local environments:

Gate::define('viewSwaggerUI', function ($user = null) {
// Custom logic here...
return in_array(optional($user)->email, [/*...*/]);
});

You can learn more about this package, get full installation instructions, and view the source code on GitHub at nextapps-be/laravel-swagger-ui.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector
MongoDB logo

MongoDB

Enhance your PHP applications with the powerful integration of MongoDB and Laravel, empowering developers to build applications with ease and efficiency. Support transactional, search, analytics and mobile use cases while using the familiar Eloquent APIs. Discover how MongoDB's flexible, modern database can transform your Laravel applications.

MongoDB

The latest

View all →
TemPHPest PHP Extension for VSCode image

TemPHPest PHP Extension for VSCode

Read article
Eloquent Filtering Package image

Eloquent Filtering Package

Read article
Building Multiplayer Minesweeper with Laravel, Livewire and Reverb image

Building Multiplayer Minesweeper with Laravel, Livewire and Reverb

Read article
Ben Holmen: Building Connections and Friendships through Pair Programming with Strangers image

Ben Holmen: Building Connections and Friendships through Pair Programming with Strangers

Read article
Laravel Herd v1.11 Adds Forge Integration, Dump Updates, and More in v1.11 image

Laravel Herd v1.11 Adds Forge Integration, Dump Updates, and More in v1.11

Read article
Chaperone, Defer, Cache::flexible, and more are now available in Laravel 11.23 image

Chaperone, Defer, Cache::flexible, and more are now available in Laravel 11.23

Read article