PHPackages hms5232/laravel-swagger - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. hms5232/laravel-swagger ActiveLibrary[API Development](/categories/api) hms5232/laravel-swagger ======================= Render OpenAPI JSON or YAML with SwaggerUI in Laravel. v0.2.0(1mo ago)32.6k[1 issues](https://github.com/hms5232/laravel-swagger/issues)MITPHPPHP ^8.0CI passing Since Oct 27Pushed 2mo ago1 watchersCompare [ Source](https://github.com/hms5232/laravel-swagger)[ Packagist](https://packagist.org/packages/hms5232/laravel-swagger)[ RSS](/packages/hms5232-laravel-swagger/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (9)Dependencies (6)Versions (11)Used By (0) laravel-swagger =============== [](#laravel-swagger) [![](https://camo.githubusercontent.com/822e6d3caae4a262326893ce6550ef422111364b1e038955d31b3e50d14c2ccd/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f686d73353233322f6c61726176656c2d737761676765723f696e636c7564655f70726572656c6561736573)](https://packagist.org/packages/hms5232/laravel-swagger)[![supported PHP version](https://camo.githubusercontent.com/e31d01dd0cec9a0d528e0263d9e897956ffb297a9c19398390c299ed6396df2d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f686d73353233322f6c61726176656c2d737761676765722f7068703f6c6f676f3d70687026636f6c6f723d253233373837636234)](https://camo.githubusercontent.com/e31d01dd0cec9a0d528e0263d9e897956ffb297a9c19398390c299ed6396df2d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f686d73353233322f6c61726176656c2d737761676765722f7068703f6c6f676f3d70687026636f6c6f723d253233373837636234)[![](https://camo.githubusercontent.com/30776d4fcf80ffff0213122e94a756f1808443b5db65270f145e5cf5541ada6b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f686d73353233322f6c61726176656c2d737761676765722f696c6c756d696e6174652f737570706f72743f636f6c6f723d666632643230266c6162656c3d4c61726176656c266c6f676f3d6c61726176656c)](https://camo.githubusercontent.com/30776d4fcf80ffff0213122e94a756f1808443b5db65270f145e5cf5541ada6b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f686d73353233322f6c61726176656c2d737761676765722f696c6c756d696e6174652f737570706f72743f636f6c6f723d666632643230266c6162656c3d4c61726176656c266c6f676f3d6c61726176656c)[![](https://camo.githubusercontent.com/75312ce3d9ee081b4bf9f0297d2b91115629ac31d9bb2f50f895f4feb512336d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f686d73353233322f6c61726176656c2d73776167676572)](https://packagist.org/packages/hms5232/laravel-swagger)[![](https://camo.githubusercontent.com/7cabcd6d8b9a3fb39dad6579432582b778c9953630b67ba64a626cc2d19e3253/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f686d73353233322f6c61726176656c2d73776167676572)](https://github.com/hms5232/laravel-swagger/blob/main/README.md)[![](https://camo.githubusercontent.com/2ff4259d96dd1e9f1208b635e001a178fdef0b580fdd6e89e1de9e718cacccaf/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f686d73353233322f6c61726176656c2d737761676765722f706870756e69742e796d6c3f6272616e63683d6d61696e266c6162656c3d74657374)](https://github.com/hms5232/laravel-swagger/actions?query=branch%3Amain) Render [OpenAPI](https://www.openapis.org/) JSON or YAML with [SwaggerUI](https://swagger.io/tools/swagger-ui/) and/or [Swagger Editor](https://editor.swagger.io/) in Laravel. Usage ----- [](#usage) ### Installation [](#installation) ``` composer require hms5232/laravel-swagger ``` or you want to install only at development environment: ``` composer require hms5232/laravel-swagger --dev ``` ### Configure [](#configure) All configurable items are in `config/swagger.php` after you run publish command: ``` php artisan vendor:publish --provider "Hms5232\LaravelSwagger\LaravelSwaggerServiceProvider" ``` If you want to override the exists config file, execute command with `--force` flag. See the config file for detail information. ### Manually register [](#manually-register) Package support auto-discovery. If you want to control when to register, you can do the following steps: 1. Edit `composer.json` make auto discovery ignore laravel-swagger: ``` "extra": { "laravel": { "dont-discover": [ "hms5232/laravel-swagger" ] } }, ``` 2. Re-generate optimized autoload files: ``` composer dump-autoload ``` 3. Edit `app/Providers/AppServiceProvider.php` define when to register: ``` use Hms5232\LaravelSwagger\LaravelSwaggerServiceProvider; // add this class AppServiceProvider extends ServiceProvider { public function register() { // set condition // for example, only register when env is "local" if ($this->app->environment('local')) { $this->app->register(LaravelSwaggerServiceProvider::class); // register laravel-swagger } } } ``` Why another package ------------------- [](#why-another-package) I just want to write a YAML file directly, and use Swagger UI serve/resolve docs. But exists projects are either using annotations or only supporting JSON (seems like bug, but does not fix.). So I develop this package, only have a view modified from [Swagger UI (unpkg)](https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation/#unpkg), two routes to link documents. > This section was written at version [0.1.0](https://github.com/hms5232/laravel-swagger/releases/tag/v0.1.0) and may be outdated in the future. LICENSE ------- [](#license) [MIT](LICENSE) ### Health Score 42 — FairBetter than 90% of packages Maintenance79 Regular maintenance activity Popularity24 Limited adoption so far Community7 Small or concentrated contributor base Maturity47 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~137 days Recently: every ~179 days Total 10 Last Release 55d ago PHP version history (3 changes)v0.1.0PHP ^7.4 || ^8.0 v0.1.2PHP ^7.3 || ^8.0 v0.1.5PHP ^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/d76044feaa2bbd819ec516eb620b2da6f8ee1f640b8ea7021a408b9d2111460e?d=identicon)[hms5232](/maintainers/hms5232) --- Top Contributors [![hms5232](https://avatars.githubusercontent.com/u/43672033?v=4)](https://github.com/hms5232 "hms5232 (66 commits)") --- Tags laravel-packageopenapiswaggerswagger-editorswagger-ui ### Code Quality Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/hms5232-laravel-swagger/health.svg) ``` [![Health](https://phpackages.com/badges/hms5232-laravel-swagger/health.svg)](https://phpackages.com/packages/hms5232-laravel-swagger) ``` ### Alternatives [mollie/laravel-mollie Mollie API client wrapper for Laravel & Mollie Connect provider for Laravel Socialite 3624.1M28](/packages/mollie-laravel-mollie)[mll-lab/laravel-graphiql Easily integrate GraphiQL into your Laravel project 683.2M9](/packages/mll-lab-laravel-graphiql)[spatie/laravel-route-discovery Auto register routes using PHP attributes 23645.0k2](/packages/spatie-laravel-route-discovery)[esign/laravel-conversions-api A laravel wrapper package around the Facebook Conversions API 69145.4k](/packages/esign-laravel-conversions-api)[didww/didww-api-3-php-sdk PHP SDK for DIDWW API 3 1218.2k](/packages/didww-didww-api-3-php-sdk)[surface/laravel-webfinger A Laravel package to create an ActivityPub webfinger. 113.8k](/packages/surface-laravel-webfinger) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)