Skip to content

Commit 6c023d9

Browse files
author
Vignesh C
committed
default options in removed and readme file updated
1 parent abe81c5 commit 6c023d9

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ Generating the swagger documentation is easy, simply run `php artisan laravel-sw
1818

1919
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"`
2020

21+
If you want to change the change the host name, you can pass a host using `--host`,
22+
for example: `php artisan laravel-swagger:generate --host="localhost/laravel"`
23+
24+
If you want to apply authentication(currently supports only jwt), you can pass a auth using `--auth`,
25+
for example: `php artisan laravel-swagger:generate --auth="jwt"`
26+
2127
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.
2228

2329
Format options are:<br>

src/GenerateSwaggerDoc.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ class GenerateSwaggerDoc extends Command
1313
*/
1414
protected $signature = 'laravel-swagger:generate
1515
{--format=json : The format of the output, current options are json and yaml}
16-
{--filter=api : Filter to a specific route prefix, such as /api or /v2/api}
17-
{--auth=jwt : Authentication to be applied globally}
16+
{--filter= : Filter to a specific route prefix, such as /api or /v2/api}
17+
{--auth= : Authentication to be applied globally}
1818
{--host= : Host name of the swagger if you wish to change the default}';
1919

2020
/**

0 commit comments

Comments
 (0)