Skip to content
Swagger for Laravel
Branch: master
Clone or download
Pull request Compare This branch is 34 commits ahead of slampenny:master.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Update SwaggervelServiceProvider.php (#16) Jul 12, 2018
tests
.gitignore
.travis.yml add several fixes and code cleanups suggested in pull requests at ori… Jan 28, 2017
README.md Update readme.md Aug 26, 2017
composer.json
phpunit.xml

README.md

Swaggervel (Swagger integration for Laravel 5)

This package combines Swagger-php and 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

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

Options

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

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. For good examples of swagger-php in action look here.

Further Notes

This package is a fork of slampenny/Swaggervel, as it is no longer maintained.

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.
You can’t perform that action at this time.