appointer/swaggervel backup
- Execute
composer require kakuilan/swaggervel:dev-main
within your laravel root directory - Add
Appointer\Swaggervel\SwaggervelServiceProvider::class
to your providers array inapp/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 intoresources/views/vendor/swaggervel
.
- www.example.com/docs <- You may find your automatically generated Swagger .json-File there
- www.example.com/api/docs <- Access to your Swagger UI
All options are well commented within the swaggervel.php config file.
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.