latrell / swagger
Swagger for Laravel 5
Installs: 61 798
Dependents: 0
Suggesters: 0
Security: 0
Stars: 41
Watchers: 2
Forks: 19
Language:HTML
Requires
- php: >=7.0.0
- illuminate/config: 5.*
- illuminate/console: 5.*
- illuminate/support: 5.*
- illuminate/view: 5.*
- zircote/swagger-php: 2.*
Requires (Dev)
- mockery/mockery: 0.9.*
- phpunit/phpunit: ~6.0
This package is not auto-updated.
Last update: 2024-10-26 17:02:55 UTC
README
For Laravel 4, please use the 0.3 branch!
Swagger for Laravel 5
This package combines swagger-php and swagger-ui into one Laravel-friendly package.
When you run your app in debug mode, Swagger will scan your Laravel app folder, generate swagger json files and deposit them to the docs-dir folder (default is "docs"). Files are then served by swagger-ui under the api-docs director.
Installation
composer require latrell/swagger dev-master
Update your packages with composer update
or install with composer install
.
Usage
To use the Swagger Service Provider, you must register the provider when bootstrapping your Laravel application. There are essentially two ways to do this.
Find the providers
key in config/app.php
and register the Swagger Service Provider.
'providers' => [ // ... 'Latrell\Swagger\SwaggerServiceProvider', ]
Run php artisan vendor:publish
to push swagger-ui to your public folder and publish the config file.
Config file config/latrell-swagger.php
is the primary way you interact with Swagger.