PHPackages                             hadeswang/jlapp-swaggervel - 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. hadeswang/jlapp-swaggervel

ActiveLibrary[API Development](/categories/api)

hadeswang/jlapp-swaggervel
==========================

A great way to integrate Swagger into Laravel

2.0.x-dev(11y ago)09MITJavaScriptPHP &gt;=5.3.0

Since Apr 21Pushed 7y ago1 watchersCompare

[ Source](https://github.com/hadeswang2016/Swaggervel)[ Packagist](https://packagist.org/packages/hadeswang/jlapp-swaggervel)[ RSS](/packages/hadeswang-jlapp-swaggervel/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (1)Versions (3)Used By (0)

Swagger 2
=========

[](#swagger-2)

This branch uses Swagger-spec 2.0 and Swagger-php 2.0. This branch also updates the Swagger-ui to version 2.1.1.

OAuth2
======

[](#oauth2)

The Swagger-ui was changed to allow inserting the OAuth 2 parameters (`client_id`, `client_secret`, `realm` and `appName`) directly in the ui. You can also pass these values in the url in the URL, like so: `http://api.appcursos.com/api-docs?client_id=my-client-id&client_secret=my-client-secret&realm=my-realm&appName=my-app-name`

To use Swaggervel for Laravel 4.2, use the version 1.0 branch ()

Swaggervel
==========

[](#swaggervel)

Swagger for Laravel

This package combines [Swagger-php](https://github.com/zircote/swagger-php) and [swagger-ui](https://github.com/wordnik/swagger-ui) into one Laravel-friendly package.

When you run your app in debug mode, Swaggervel will scan your app folder (or any folder that is set under the "app-dir" variable in the packages config), generate swagger json files and deposit them to the doc-dir folder (default is `/docs`). Files are then served by swagger-ui under the api-docs director.

Installation
============

[](#installation)

- Add `Jlapp\Swaggervel\SwaggervelServiceProvider` to your providers array in `app/config/app.php` above your route provider, to avoid any catch-all routes
- Run `php artisan vendor:publish` to push swagger-ui to your public folder.

Example
=======

[](#example)

- [www.example.com/docs](http://www.example.com/docs) &lt;- swagger JSON files are visible
- [www.example.com/api-docs](http://www.example.com/api-docs) &lt;- swagger ui is visible.

Options
=======

[](#options)

Uncomment the "viewHeaders" option in the Config file to add headers to your view.

How to Use Swagger-php
======================

[](#how-to-use-swagger-php)

The actual Swagger spec is beyond the scope of this package. All Swaggervel does is package up swagger-php and swagger-ui in a Laravel-friendly fashion, and tries to make it easy to serve. For info on how to use swagger-php [look here](http://zircote.com/swagger-php/). For good examples of swagger-php in action [look here](https://github.com/zircote/swagger-php/tree/master/Examples/Petstore).
===========================================================================================================================================================================================================================================================================================================================================================================================================

[](#the-actual-swagger-spec-is-beyond-the-scope-of-this-package-all-swaggervel-does-is-package-up-swagger-php-and-swagger-ui-in-a-laravel-friendly-fashion-and-tries-to-make-it-easy-to-serve-for-info-on-how-to-use-swagger-php-look-here-for-good-examples-of-swagger-php-in-action-look-here)

### For Laravel 5, please use the [2.0 branch](https://github.com/slampenny/Swaggervel/tree/2.0)!

[](#for-laravel-5-please-use-the-20-branch)

### For Laravel 4, please use the [1.0 branch](https://github.com/slampenny/Swaggervel/tree/1.0)!

[](#for-laravel-4-please-use-the-10-branch)

Swaggervel
==========

[](#swaggervel-1)

Swagger for Laravel

This package combines [Swagger-php](https://github.com/zircote/swagger-php) and [swagger-ui](https://github.com/wordnik/swagger-ui) into one Laravel-friendly package.

When you run your app in debug mode, Swaggervel will scan your app folder (or any folder that is set under the "app-dir" variable in the packages config), generate swagger json files and deposit them to the doc-dir folder (default is `/docs`). Files are then served by swagger-ui under the api-docs director.

Installation
============

[](#installation-1)

- Add `Jlapp\Swaggervel\SwaggervelServiceProvider` to your providers array in `app/config/app.php` above your routes provider (to avoid catch all routes)
- Run `php artisan vendor:publish` to push config files to your app folder.

Example
=======

[](#example-1)

- [www.example.com/docs](http://www.example.com/docs) &lt;- swagger JSON files are visible
- [www.example.com/api-docs](http://www.example.com/api-docs) &lt;- swagger ui is visible.

Options
=======

[](#options-1)

Uncomment the "viewHeaders" option in the Config file to add headers to your view.

How to Use Swagger-php
======================

[](#how-to-use-swagger-php-1)

The actual Swagger spec is beyond the scope of this package. All Swaggervel does is package up swagger-php and swagger-ui in a Laravel-friendly fashion, and tries to make it easy to serve. For info on how to use swagger-php [look here](http://zircote.com/swagger-php/). For good examples of swagger-php in action [look here](https://github.com/zircote/swagger-php/tree/master/Examples/Petstore).

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~77 days

Total

2

Last Release

3962d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/5d40b23fe2eb33008e0047257f9c7001c83446754f4ad5f02c5ec231e9895568?d=identicon)[hadeswang2016](/maintainers/hadeswang2016)

---

Top Contributors

[![slampenny](https://avatars.githubusercontent.com/u/7809881?v=4)](https://github.com/slampenny "slampenny (18 commits)")[![tralves](https://avatars.githubusercontent.com/u/2600867?v=4)](https://github.com/tralves "tralves (11 commits)")[![hadeswang2016](https://avatars.githubusercontent.com/u/18191772?v=4)](https://github.com/hadeswang2016 "hadeswang2016 (5 commits)")[![thmsu](https://avatars.githubusercontent.com/u/67536769?v=4)](https://github.com/thmsu "thmsu (3 commits)")[![cliveza](https://avatars.githubusercontent.com/u/1900666?v=4)](https://github.com/cliveza "cliveza (2 commits)")[![w0rd-driven](https://avatars.githubusercontent.com/u/489986?v=4)](https://github.com/w0rd-driven "w0rd-driven (2 commits)")[![UrosSimovic](https://avatars.githubusercontent.com/u/11682124?v=4)](https://github.com/UrosSimovic "UrosSimovic (1 commits)")[![phazei](https://avatars.githubusercontent.com/u/431395?v=4)](https://github.com/phazei "phazei (1 commits)")[![jbrooksuk](https://avatars.githubusercontent.com/u/246103?v=4)](https://github.com/jbrooksuk "jbrooksuk (1 commits)")[![kevin91nl](https://avatars.githubusercontent.com/u/3481474?v=4)](https://github.com/kevin91nl "kevin91nl (1 commits)")[![lahaxearnaud](https://avatars.githubusercontent.com/u/1364221?v=4)](https://github.com/lahaxearnaud "lahaxearnaud (1 commits)")[![AlexandrCe](https://avatars.githubusercontent.com/u/5671295?v=4)](https://github.com/AlexandrCe "AlexandrCe (1 commits)")[![riemers](https://avatars.githubusercontent.com/u/682041?v=4)](https://github.com/riemers "riemers (1 commits)")

---

Tags

apilaraveldocumentationswaggerl5L4

### Embed Badge

![Health badge](/badges/hadeswang-jlapp-swaggervel/health.svg)

```
[![Health](https://phpackages.com/badges/hadeswang-jlapp-swaggervel/health.svg)](https://phpackages.com/packages/hadeswang-jlapp-swaggervel)
```

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[jlapp/swaggervel

A great way to integrate Swagger into Laravel

492931.6k2](/packages/jlapp-swaggervel)[darkaonline/swagger-lume

OpenApi or Swagger integration to Lumen

3372.3M3](/packages/darkaonline-swagger-lume)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
