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

ActiveLibrary[API Development](/categories/api)

pronabsen/swaggervel
====================

A great way to integrate Swagger into Laravel

1.0(3y ago)04MITPHPPHP ^7.1|^8.0

Since Jul 10Pushed 3y ago1 watchersCompare

[ Source](https://github.com/pronabsen/swaggervel)[ Packagist](https://packagist.org/packages/pronabsen/swaggervel)[ RSS](/packages/pronabsen-swaggervel/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (3)Versions (2)Used By (0)

Swaggervel (Swagger integration for Laravel 5)
==============================================

[](#swaggervel-swagger-integration-for-laravel-5)

This package combines [Swagger-php](https://github.com/zircote/swagger-php) and [swagger-ui](https://github.com/swagger-api/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)

- Execute `composer require appointer/swaggervel --dev` within your laravel root directory
- Add `Appointer\Swaggervel\SwaggervelServiceProvider::class` to your providers array in `app/config/app.php` above your route provider, to avoid any catch-all routes
- Run `php artisan vendor:publish --tag=public` to push swagger-ui to your public folder (can be found in public/vendor/swaggervel).
- Optionally run `php artisan vendor:publish --tag=config` to push the swaggervel default config into your application's config directory.
- Optionally run `php artisan vendor:publish --tag=views` to push the swaggervel index view file into `resources/views/vendor/swaggervel`.

Examples (when using the default configuration)
-----------------------------------------------

[](#examples-when-using-the-default-configuration)

- [www.example.com/docs](http://www.example.com/docs) <- You may find your automatically generated Swagger .json-File there
- [www.example.com/api/docs](http://www.example.com/api/docs) <- Access to your Swagger UI

Options
-------

[](#options)

All options are well commented within the swaggervel.php config file.

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).

Further Notes
-------------

[](#further-notes)

This package is a fork of [slampenny/Swaggervel](https://github.com/slampenny/Swaggervel), as it is no longer maintained.

TODO
----

[](#todo)

- the handling of the /doc call is still really inconsistent, as you cannot change the file name (api-docs.json), but are able to change the file you acces when using the /doc route.

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity52

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

Unknown

Total

1

Last Release

1402d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/4afac3ef225c5a71d5d770aa7ac04c0c9ee9662abed9030a1ef00727766ee1b1?d=identicon)[pronabsen](/maintainers/pronabsen)

---

Top Contributors

[![pronabsen](https://avatars.githubusercontent.com/u/30025867?v=4)](https://github.com/pronabsen "pronabsen (2 commits)")

---

Tags

apilaraveldocumentationswagger

### Embed Badge

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

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

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[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)