Skip to content

Commit b8bdbf9

Browse files
authored
Update the generate command (#11)
* update the generate command It seems the command has been updated to `php artisan swagger:generate` * Update README.md update command as well
1 parent 1ea9ac8 commit b8bdbf9

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ Laravel Swagger Docs works based on recommended practices by Laravel. It will pa
3333
One thing to note is this library leans on being explicit. It will choose to include keys even if they have a default. For example it chooses to say a route has a deprecated value of false rather than leaving it out. I believe this makes reading the documentation easier by not leaving important information out. The file can be easily cleaned up afterwards if the user chooses to leave out the defaults.
3434

3535
### Command line
36-
Generating the swagger documentation is easy, simply run `php artisan laravel-swagger:generate` in your project root. The output of the command will be stored in your storage path linked in config file.
36+
Generating the swagger documentation is easy, simply run `php artisan swagger:generate` in your project root. The output of the command will be stored in your storage path linked in config file.
3737

38-
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"`
38+
If you wish to generate docs for a subset of your routes, you can pass a filter using `--filter`, for example: `php artisan swagger:generate --filter="/api"`
3939

4040
You can also configure your swagger.php file to always generate schema when accessing Swagger UI or just by adding this line in your .env: `SWAGGER_GENERATE_ALWAYS=true`
4141

0 commit comments

Comments
 (0)