Download the PHP package vigneshc91/laravel-swagger without Composer
On this page you can find all versions of the php package vigneshc91/laravel-swagger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vigneshc91/laravel-swagger
More information about vigneshc91/laravel-swagger
Files in vigneshc91/laravel-swagger
Package laravel-swagger
Short Description Auto generates the swagger documentation for a laravel project
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 laravel-swagger
Laravel Swagger
This package scans your laravel project's routes and auto generates a Swagger 2.0 documentation for you. If you inject Form Request classes in your controller's actions as request validation, it will also generate the parameters for each request that has them. It will take into account wether the request is a GET/HEAD/DELETE or a POST/PUT/PATCH request and make its best guess as to the type of parameter object it should generate. It will also generate the path parameters if you route contains them.
Installation
The package can easily be installed by running composer require vigneshc91/laravel-swagger in your project's root folder.
If you are running a version of Laravel < 5.5 also make sure you add Vigneshc91\LaravelSwagger\SwaggerServiceProvider::class to the providers array in config/app.php.
This will register the artisan command that will be available to you.
You can also override the default config provided by the application by running php artisan vendor:publish --provider "LaravelSwagger\SwaggerServiceProvider" in your projects root and change the configuration in the new config/laravel-swagger.php file created.
Usage
Generating the swagger documentation is easy, simply run php artisan laravel-swagger:generate in your project root. Keep in mind the command will simply print out the output in your console. If you want the docs saved in a file you can reroute the output like so: php artisan laravel-swagger:generate > swagger.json
If you wish to generate docs for a subset of your routes, you can pass a filter using --filter, for example: php artisan laravel-swagger:generate --filter="/api"
If you want to change the change the host name, you can pass a host using --host,
for example: php artisan laravel-swagger:generate --host="localhost/laravel"
If you want to apply authentication(currently supports only jwt), you can pass a auth using --auth,
for example: php artisan laravel-swagger:generate --auth="jwt"
By default, laravel-swagger prints out the documentation in json format, if you want it in YAML format you can override the format using the --format flag. Make sure to have the yaml extension installed if you choose to do so.
Format options are:
json
yaml
Example
Say you have a route /api/users/{id} that maps to UserController@show
Your sample controller might look like this:
And the FormRequest class might look like this:
Running php artisan laravel-swagger:generate > swagger.json will generate the following file:
