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

ActiveLibrary[API Development](/categories/api)

robosys-labs/swaggervel
=======================

A great way to integrate Swagger into Laravel

01PHP

Since Aug 14Pushed 3y agoCompare

[ Source](https://github.com/robosys-labs/swaggervel)[ Packagist](https://packagist.org/packages/robosys-labs/swaggervel)[ RSS](/packages/robosys-labs-swaggervel/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependenciesVersions (1)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) &lt;- You may find your automatically generated Swagger .json-File there
- [www.example.com/api/docs](http://www.example.com/api/docs) &lt;- 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

15

—

LowBetter than 3% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity1

Limited adoption so far

Community17

Small or concentrated contributor base

Maturity25

Early-stage or recently created project

 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/f6ca02994d891ce4ac871d0cf344888f9b2d7a52d9cb424be8a4e908d0d4a84b?d=identicon)[xwiz](/maintainers/xwiz)

---

Top Contributors

[![fgreinus](https://avatars.githubusercontent.com/u/1236785?v=4)](https://github.com/fgreinus "fgreinus (23 commits)")[![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)")[![jamisonkirk](https://avatars.githubusercontent.com/u/740442?v=4)](https://github.com/jamisonkirk "jamisonkirk (5 commits)")[![k911](https://avatars.githubusercontent.com/u/10072889?v=4)](https://github.com/k911 "k911 (4 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)")[![xwiz](https://avatars.githubusercontent.com/u/3619843?v=4)](https://github.com/xwiz "xwiz (2 commits)")[![UrosSimovic](https://avatars.githubusercontent.com/u/11682124?v=4)](https://github.com/UrosSimovic "UrosSimovic (1 commits)")[![vishalinfyom](https://avatars.githubusercontent.com/u/33887755?v=4)](https://github.com/vishalinfyom "vishalinfyom (1 commits)")[![xAockd](https://avatars.githubusercontent.com/u/3390348?v=4)](https://github.com/xAockd "xAockd (1 commits)")[![phazei](https://avatars.githubusercontent.com/u/431395?v=4)](https://github.com/phazei "phazei (1 commits)")[![bastien-phi](https://avatars.githubusercontent.com/u/10199039?v=4)](https://github.com/bastien-phi "bastien-phi (1 commits)")[![drmonkeyninja](https://avatars.githubusercontent.com/u/357623?v=4)](https://github.com/drmonkeyninja "drmonkeyninja (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)")

### Embed Badge

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

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

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M475](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M270](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M186](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[microsoft/microsoft-graph

The Microsoft Graph SDK for PHP

65723.5M95](/packages/microsoft-microsoft-graph)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)

PHPackages © 2026

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