Download the PHP package darus-x/swaggervel without Composer
On this page you can find all versions of the php package darus-x/swaggervel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download darus-x/swaggervel
More information about darus-x/swaggervel
Files in darus-x/swaggervel
Package swaggervel
Short Description A great way to integrate Swagger into Laravel
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package swaggervel
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 --devwithin your laravel root directory - Add
Appointer\Swaggervel\SwaggervelServiceProvider::classto your providers array inapp/config/app.phpabove your route provider, to avoid any catch-all routes - Run
php artisan vendor:publish --tag=publicto push swagger-ui to your public folder (can be found in public/vendor/swaggervel). - Optionally run
php artisan vendor:publish --tag=configto push the swaggervel default config into your application's config directory. - Optionally run
php artisan vendor:publish --tag=viewsto push the swaggervel index view file intoresources/views/vendor/swaggervel.
Examples (when using the default configuration)
- www.example.com/docs <- You may find your automatically generated Swagger .json-File there
- www.example.com/api/docs <- Access to your Swagger UI
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.
